.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Pithub::GitData::References 3pm"
.TH Pithub::GitData::References 3pm "2014-05-18" "perl v5.18.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Pithub::GitData::References \- Github v3 Git Data References API
.SH "VERSION"
.IX Header "VERSION"
version 0.01025
.SH "METHODS"
.IX Header "METHODS"
.SS "create"
.IX Subsection "create"
.IP "\(bu" 4
Create a Reference
.Sp
.Vb 1
\&    POST /repos/:user/:repo/git/refs
.Ve
.Sp
Parameters:
.RS 4
.IP "\(bu" 4
\&\fBuser\fR: mandatory string
.IP "\(bu" 4
\&\fBrepo\fR: mandatory string
.IP "\(bu" 4
\&\fBdata\fR: mandatory hashref, having following keys:
.RS 4
.IP "\(bu" 4
\&\fBref\fR: mandatory string of the name of the fully qualified
reference (ie: refs/heads/master). If it doesn't start with
\&'refs' and have at least two slashes, it will be rejected.
.IP "\(bu" 4
\&\fBsha\fR: mandatory string of the \s-1SHA1\s0 value to set this
reference to.
.RE
.RS 4
.RE
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 9
\&    my $r = Pithub::GitData::References\->new;
\&    my $result = $r\->create(
\&        user => \*(Aqplu\*(Aq,
\&        repo => \*(AqPithub\*(Aq,
\&        data => {
\&            ref => \*(Aqrefs/heads/master\*(Aq,
\&            sha => \*(Aq827efc6d56897b048c772eb4087f854f46256132\*(Aq .
\&        }
\&    );
.Ve
.RE
.SS "get"
.IX Subsection "get"
.IP "\(bu" 4
Get a Reference
.Sp
.Vb 1
\&    GET /repos/:user/:repo/git/refs/:ref
.Ve
.Sp
Parameters:
.RS 4
.IP "\(bu" 4
\&\fBuser\fR: mandatory string
.IP "\(bu" 4
\&\fBrepo\fR: mandatory string
.IP "\(bu" 4
\&\fBref\fR: mandatory string
.Sp
The key \fBref\fR must be formatted as \f(CW\*(C`heads/branch\*(C'\fR, not just
\&\f(CW\*(C`branch\*(C'\fR. For example, the call to get the data for a branch
named \f(CW\*(C`sc/featureA\*(C'\fR would be: \f(CW\*(C`heads/sc/featureA\*(C'\fR
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 6
\&    my $r = Pithub::GitData::References\->new;
\&    my $result = $r\->get(
\&        user => \*(Aqplu\*(Aq,
\&        repo => \*(AqPithub\*(Aq,
\&        ref  => \*(Aqheads/master\*(Aq
\&    );
.Ve
.Sp
Response: \fBStatus: 200 \s-1OK\s0\fR
.Sp
.Vb 9
\&    {
\&        "ref": "refs/heads/sc/featureA",
\&        "url": "https://api.github.com/repos/octocat/Hello\-World/git/refs/heads/sc/featureA",
\&        "object": {
\&            "type": "commit",
\&            "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
\&            "url": "https://api.github.com/repos/octocat/Hello\-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd"
\&        }
\&    }
.Ve
.RE
.SS "list"
.IX Subsection "list"
.IP "\(bu" 4
Get all References
.Sp
.Vb 1
\&    GET /repos/:user/:repo/git/refs
.Ve
.Sp
This will return an array of all the references on the system,
including things like notes and stashes if they exist on the server.
Anything in the namespace, not just heads and tags, though that
would be the most common.
.Sp
Parameters:
.RS 4
.IP "\(bu" 4
\&\fBuser\fR: mandatory string
.IP "\(bu" 4
\&\fBrepo\fR: mandatory string
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 5
\&    my $r = Pithub::GitData::References\->new;
\&    my $result = $r\->list(
\&        user => \*(Aqplu\*(Aq,
\&        repo => \*(AqPithub\*(Aq,
\&    );
.Ve
.RE
.IP "\(bu" 4
You can also request a sub-namespace. For example, to get all the
tag references, you can call:
.Sp
.Vb 1
\&    GET /repos/:user/:repo/git/refs/tags
.Ve
.Sp
Parameters:
.RS 4
.IP "\(bu" 4
\&\fBuser\fR: mandatory string
.IP "\(bu" 4
\&\fBrepo\fR: mandatory string
.IP "\(bu" 4
\&\fBref\fR: mandatory string
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 6
\&    my $r = Pithub::GitData::References\->new;
\&    my $result = $r\->list(
\&        user => \*(Aqplu\*(Aq,
\&        repo => \*(AqPithub\*(Aq,
\&        ref  => \*(Aqtags\*(Aq,
\&    );
.Ve
.Sp
Response: \fBStatus: 200 \s-1OK\s0\fR
.Sp
.Vb 10
\&    [
\&        {
\&            "object": {
\&                "type": "commit",
\&                "sha": "1c5230f42d6d3e376162591f223fc4130d671937",
\&                "url": "https://api.github.com/repos/plu/Pithub/git/commits/1c5230f42d6d3e376162591f223fc4130d671937"
\&            },
\&            "ref": "refs/tags/v0.01000",
\&            "url": "https://api.github.com/repos/plu/Pithub/git/refs/tags/v0.01000"
\&        },
\&        {
\&            "object": {
\&                "type": "tag",
\&                "sha": "ef328a0679a992bd2c0ac537cf19d379f1c8d177",
\&                "url": "https://api.github.com/repos/plu/Pithub/git/tags/ef328a0679a992bd2c0ac537cf19d379f1c8d177"
\&            },
\&            "ref": "refs/tags/v0.01001",
\&            "url": "https://api.github.com/repos/plu/Pithub/git/refs/tags/v0.01001"
\&        }
\&    ]
.Ve
.RE
.SS "update"
.IX Subsection "update"
.IP "\(bu" 4
Update a Reference
.Sp
.Vb 1
\&    PATCH /repos/:user/:repo/git/refs/:ref
.Ve
.Sp
Parameters:
.RS 4
.IP "\(bu" 4
\&\fBuser\fR: mandatory string
.IP "\(bu" 4
\&\fBrepo\fR: mandatory string
.IP "\(bu" 4
\&\fBref\fR: mandatory string
.IP "\(bu" 4
\&\fBdata\fR: mandatory hashref, having following keys:
.RS 4
.IP "\(bu" 4
\&\fBsha\fR: mandatory string of the \s-1SHA1\s0 value to set this
reference to.
.IP "\(bu" 4
\&\fBforce\fR: optional boolean indicating whether to force the update or
to make sure the update is a fast-forward update. The default is
\&\f(CW\*(C`false\*(C'\fR so leaving this out or setting it to \f(CW\*(C`false\*(C'\fR will
make sure you're not overwriting work.
.RE
.RS 4
.RE
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 10
\&    my $r = Pithub::GitData::References\->new;
\&    my $result = $r\->update(
\&        user => \*(Aqplu\*(Aq,
\&        repo => \*(AqPithub\*(Aq,
\&        ref  => \*(Aqtags/v1.0\*(Aq,
\&        data => {
\&            force => 1,
\&            sha   => \*(Aqaa218f56b14c9653891f9e74264a383fa43fefbd\*(Aq,
\&        }
\&    );
.Ve
.Sp
Response: \fBStatus: 200 \s-1OK\s0\fR
.Sp
.Vb 11
\&    [
\&        {
\&            "ref": "refs/heads/sc/featureA",
\&            "url": "https://api.github.com/repos/octocat/Hello\-World/git/refs/heads/sc/featureA",
\&            "object": {
\&                "type": "commit",
\&                "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
\&                "url": "https://api.github.com/repos/octocat/Hello\-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd"
\&            }
\&        }
\&    ]
.Ve
.RE
.SH "AUTHOR"
.IX Header "AUTHOR"
Johannes Plunien <plu@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2011 by Johannes Plunien.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.