.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 >0, 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
.\" ========================================================================
.\"
.IX Title "Pithub::GitData::Trees 3pm"
.TH Pithub::GitData::Trees 3pm "2023-09-02" "perl v5.36.0" "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::Trees \- Github v3 Git Data Trees API
.SH "VERSION"
.IX Header "VERSION"
version 0.01041
.SH "METHODS"
.IX Header "METHODS"
.SS "create"
.IX Subsection "create"
The tree creation \s-1API\s0 will take nested entries as well. If both a
tree and a nested path modifying that tree are specified, it will
overwrite the contents of that tree with the new path contents and
write a new tree out.
.IP "\(bu" 4
Create a Tree
.Sp
.Vb 1
\&    POST /repos/:user/:repo/git/trees
.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
\&\fBbase_tree\fR: optional String of the \s-1SHA1\s0 of the tree you want to
update with new data.
.IP "\(bu" 4
\&\fBtree\fR: mandatory arrayref of hashrefs, having following keys:
.RS 4
.IP "\(bu" 4
\&\fBpath\fR: mandatory string of the file referenced in the tree.
.IP "\(bu" 4
\&\fBmode\fR: mandatory string of the file mode \- one of \f(CW100644\fR
for file (blob), \f(CW100755\fR for executable (blob), \f(CW040000\fR
for subdirectory (tree), \f(CW160000\fR for submodule (commit) or
\&\f(CW120000\fR for a blob that specifies the path of a symlink.
.IP "\(bu" 4
\&\fBtype\fR: mandatory string of \f(CW\*(C`blob\*(C'\fR, \f(CW\*(C`tree\*(C'\fR, \f(CW\*(C`commit\*(C'\fR.
.IP "\(bu" 4
\&\fBsha\fR: mandatory string of \s-1SHA1\s0 checksum \s-1ID\s0 of the object in the tree.
.IP "\(bu" 4
\&\fBcontent\fR: String of content you want this file to have \- GitHub will
write this blob out and use that \s-1SHA\s0 for this entry. Use either this
or \f(CW\*(C`tree.sha\*(C'\fR.
.RE
.RS 4
.RE
.RE
.RS 4
.RE
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 10
\&    my $t = Pithub::GitData::Trees\->new;
\&    my $result = $t\->create(
\&        user => \*(Aqoctocat\*(Aq,
\&        repo => \*(AqHello\-World\*(Aq,
\&        data => {
\&            tree => [
\&                {
\&                    path => \*(Aqfile.rb\*(Aq,
\&                    mode => \*(Aq100644\*(Aq,
\&                    type => \*(Aqblob\*(Aq,
\&                    sha  => \*(Aq7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\*(Aq,
\&                }
\&            ]
\&        }
\&    );
.Ve
.Sp
Response: \fBStatus: 201 Created\fR
.Sp
.Vb 10
\&    {
\&        "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7",
\&        "url": "https://api.github.com/repo/octocat/Hello\-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7",
\&        "tree": [
\&        {
\&            "path": "file.rb",
\&            "mode": "100644",
\&            "type": "blob",
\&            "size": 132,
\&            "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b",
\&            "url": "https://api.github.com/octocat/Hello\-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b"
\&        }
\&        ]
\&    }
.Ve
.RE
.SS "get"
.IX Subsection "get"
.IP "\(bu" 4
Get a Tree
.Sp
.Vb 1
\&    GET /repos/:user/:repo/git/trees/:sha
.Ve
.Sp
Parameters:
.RS 4
.IP "\(bu" 4
\&\fBuser\fR: mandatory string
.IP "\(bu" 4
\&\fBrepo\fR: mandatory string
.IP "\(bu" 4
\&\fBsha\fR: mandatory string
.IP "\(bu" 4
\&\fBrecursive\fR: optional boolean
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 6
\&    my $t = Pithub::GitData::Trees\->new;
\&    my $result = $t\->get(
\&        user => \*(Aqplu\*(Aq,
\&        repo => \*(AqPithub\*(Aq,
\&        sha  => \*(Aqdf21b2660fb6\*(Aq
\&    );
.Ve
.Sp
Response: \fBStatus: 200 \s-1OK\s0\fR
.Sp
.Vb 10
\&    {
\&        "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
\&        "url": "https://api.github.com/repo/octocat/Hello\-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
\&        "tree": [
\&        {
\&            "path": "file.rb",
\&            "mode": "100644",
\&            "type": "blob",
\&            "size": 30,
\&            "sha": "44b4fc6d56897b048c772eb4087f854f46256132",
\&            "url": "https://api.github.com/octocat/Hello\-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132"
\&        },
\&        {
\&            "path": "subdir",
\&            "mode": "040000",
\&            "type": "tree",
\&            "sha": "f484d249c660418515fb01c2b9662073663c242e",
\&            "url": "https://api.github.com/octocat/Hello\-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e"
\&        },
\&        {
\&            "path": "exec_file",
\&            "mode": "100755",
\&            "type": "blob",
\&            "size": 75,
\&            "sha": "45b983be36b73c0788dc9cbcb76cbb80fc7bb057",
\&            "url": "https://api.github.com/octocat/Hello\-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057"
\&        }
\&        ]
\&    }
.Ve
.RE
.IP "\(bu" 4
Get a Tree Recursively
.Sp
.Vb 1
\&    GET /repos/:user/:repo/git/trees/:sha?recursive=1
.Ve
.Sp
Parameters:
.RS 4
.IP "\(bu" 4
\&\fBuser\fR: mandatory string
.IP "\(bu" 4
\&\fBrepo\fR: mandatory string
.IP "\(bu" 4
\&\fBsha\fR: mandatory string
.IP "\(bu" 4
\&\fBrecursive\fR: optional boolean
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 7
\&    my $t = Pithub::GitData::Trees\->new;
\&    my $result = $t\->get(
\&        user      => \*(Aqplu\*(Aq,
\&        repo      => \*(AqPithub\*(Aq,
\&        sha       => \*(Aqdf21b2660fb6\*(Aq,
\&        recursive => 1,
\&    );
.Ve
.Sp
Response: \fBStatus: 200 \s-1OK\s0\fR
.Sp
.Vb 10
\&    {
\&        "sha": "fc6274d15fa3ae2ab983129fb037999f264ba9a7",
\&        "url": "https://api.github.com/repo/octocat/Hello\-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7",
\&        "tree": [
\&        {
\&            "path": "subdir/file.txt",
\&            "mode": "100644",
\&            "type": "blob",
\&            "size": 132,
\&            "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b",
\&            "url": "https://api.github.com/octocat/Hello\-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b"
\&        }
\&        ]
\&    }
.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.