.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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::Repos::Commits 3pm"
.TH Pithub::Repos::Commits 3pm "2021-02-15" "perl v5.32.1" "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::Repos::Commits \- Github v3 Repo Commits API
.SH "VERSION"
.IX Header "VERSION"
version 0.01036
.SH "METHODS"
.IX Header "METHODS"
.SS "compare"
.IX Subsection "compare"
.IP "\(bu" 4
Compare two commits
.Sp
.Vb 1
\& GET /repos/:user/:repo/compare/:base...:head
.Ve
.Sp
Examples:
.Sp
.Vb 7
\& my $c = Pithub::Repos::Commits\->new;
\& my $result = $c\->compare(
\& user => \*(Aqplu\*(Aq,
\& repo => \*(AqPithub\*(Aq,
\& base => \*(Aqv0.01008\*(Aq,
\& head => \*(Aq master \*(Aq,
\& );
.Ve
.SS "create_comment"
.IX Subsection "create_comment"
.IP "\(bu" 4
Create a commit comment
.Sp
.Vb 1
\& POST /repos/:user/:repo/commits/:sha/comments
.Ve
.Sp
Examples:
.Sp
.Vb 7
\& my $c = Pithub::Repos::Commits\->new;
\& my $result = $c\->create_comment(
\& user => \*(Aqplu\*(Aq,
\& repo => \*(AqPithub\*(Aq,
\& sha => \*(Aqdf21b2660fb6\*(Aq,
\& data => { body => \*(Aqsome comment\*(Aq },
\& );
.Ve
.SS "delete_comment"
.IX Subsection "delete_comment"
.IP "\(bu" 4
Delete a commit comment
.Sp
.Vb 1
\& DELETE /repos/:user/:repo/comments/:id
.Ve
.Sp
Examples:
.Sp
.Vb 6
\& my $c = Pithub::Repos::Commits\->new;
\& my $result = $c\->delete_comment(
\& user => \*(Aqplu\*(Aq,
\& repo => \*(AqPithub\*(Aq,
\& comment_id => 1,
\& );
.Ve
.SS "get"
.IX Subsection "get"
.IP "\(bu" 4
Get a single commit
.Sp
.Vb 1
\& GET /repos/:user/:repo/commits/:sha
.Ve
.Sp
Examples:
.Sp
.Vb 6
\& my $c = Pithub::Repos::Commits\->new;
\& my $result = $c\->get(
\& user => \*(Aqplu\*(Aq,
\& repo => \*(AqPithub\*(Aq,
\& sha => \*(Aqdf21b2660fb6\*(Aq,
\& );
.Ve
.SS "get_comment"
.IX Subsection "get_comment"
.IP "\(bu" 4
Get a single commit comment
.Sp
.Vb 1
\& GET /repos/:user/:repo/comments/:id
.Ve
.Sp
Examples:
.Sp
.Vb 6
\& my $c = Pithub::Repos::Commits\->new;
\& my $result = $c\->get_comment(
\& user => \*(Aqplu\*(Aq,
\& repo => \*(AqPithub\*(Aq,
\& comment_id => 1,
\& );
.Ve
.SS "list"
.IX Subsection "list"
.IP "\(bu" 4
List commits on a repository
.Sp
.Vb 1
\& GET /repos/:user/:repo/commits
.Ve
.Sp
Examples:
.Sp
.Vb 5
\& my $c = Pithub::Repos::Commits\->new;
\& my $result = $c\->list(
\& user => \*(Aqplu\*(Aq,
\& repo => \*(AqPithub\*(Aq,
\& );
.Ve
.SS "list_comments"
.IX Subsection "list_comments"
.IP "\(bu" 4
List commit comments for a repository
.Sp
Commit Comments leverage these custom mime types. You can read more
about the use of mimes types in the \s-1API\s0 here. See also:
.
.Sp
.Vb 1
\& GET /repos/:user/:repo/comments
.Ve
.Sp
Examples:
.Sp
.Vb 5
\& my $c = Pithub::Repos::Commits\->new;
\& my $result = $c\->list_comments(
\& user => \*(Aqplu\*(Aq,
\& repo => \*(AqPithub\*(Aq,
\& );
.Ve
.IP "\(bu" 4
List comments for a single commit
.Sp
.Vb 1
\& GET /repos/:user/:repo/commits/:sha/comments
.Ve
.Sp
Examples:
.Sp
.Vb 6
\& my $c = Pithub::Repos::Commits\->new;
\& my $result = $c\->list_comments(
\& user => \*(Aqplu\*(Aq,
\& repo => \*(AqPithub\*(Aq,
\& sha => \*(Aqdf21b2660fb6\*(Aq,
\& );
.Ve
.SS "update_comment"
.IX Subsection "update_comment"
.IP "\(bu" 4
Update a commit comment
.Sp
.Vb 1
\& PATCH /repos/:user/:repo/comments/:id
.Ve
.Sp
Examples:
.Sp
.Vb 7
\& my $c = Pithub::Repos::Commits\->new;
\& my $result = $c\->update_comment(
\& user => \*(Aqplu\*(Aq,
\& repo => \*(AqPithub\*(Aq,
\& comment_id => 1,
\& data => { body => \*(Aqupdated comment\*(Aq },
\& );
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Johannes Plunien
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2011\-2019 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.