.\" 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::GitData::Tags 3pm" .TH Pithub::GitData::Tags 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::GitData::Tags \- Github v3 Git Data Tags API .SH "VERSION" .IX Header "VERSION" version 0.01036 .SH "DESCRIPTION" .IX Header "DESCRIPTION" This tags api only deals with tag objects \- so only annotated tags, not lightweight tags. .SH "METHODS" .IX Header "METHODS" .SS "create" .IX Subsection "create" .IP "\(bu" 4 Create a Tag .Sp Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the \f(CW\*(C`refs/tags/[tag]\*(C'\fR reference. If you want to create a lightweight tag, you simply have to create the reference \- this call would be unnecessary. .Sp .Vb 1 \& POST /repos/:user/:repo/git/tags .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 \&\fBtag\fR: mandatory string of the tag .IP "\(bu" 4 \&\fBmessage\fR: mandatory string of the tag message .IP "\(bu" 4 \&\fBobject\fR: mandatory stringof the \s-1SHA\s0 of the git object this is tagging .IP "\(bu" 4 \&\fBtype\fR: mandatory string of the type of the object we're tagging. Normally this is a \f(CW\*(C`commit\*(C'\fR but it can also be a \f(CW\*(C`tree\*(C'\fR or a \f(CW\*(C`blob\*(C'\fR. .IP "\(bu" 4 \&\fBtagger\fR: mandatory hashref, having following keys: .RS 4 .IP "\(bu" 4 \&\fBname\fR: string of the name of the author of the tag .IP "\(bu" 4 \&\fBemail\fR: string of the email of the author of the tag .IP "\(bu" 4 \&\fBdate\fR: timestamp of when this commit was tagged .RE .RS 4 .RE .RE .RS 4 .RE .RE .RS 4 .Sp Examples: .Sp .Vb 10 \& my $t = Pithub::GitData::Tags\->new; \& my $result = $t\->create( \& user => \*(Aqplu\*(Aq, \& repo => \*(AqPithub\*(Aq, \& data => { \& tagger => { \& date => \*(Aq2011\-06\-17T14:53:35\-07:00\*(Aq, \& email => \*(Aqschacon@gmail.com\*(Aq, \& name => \*(AqScott Chacon\*(Aq, \& }, \& message => \*(Aqinitial version\*(Aq, \& object => \*(Aqc3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\*(Aq, \& tag => \*(Aqv0.0.1\*(Aq, \& type => \*(Aqcommit\*(Aq, \& } \& ); .Ve .Sp Response: \fBStatus: 201 Created\fR .Sp .Vb 10 \& { \& "tag": "v0.0.1", \& "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", \& "url": "https://api.github.com/repos/octocat/Hello\-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", \& "message": "initial version\en", \& "tagger": { \& "name": "Scott Chacon", \& "email": "schacon@gmail.com", \& "date": "2011\-06\-17T14:53:35\-07:00" \& }, \& "object": { \& "type": "commit", \& "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", \& "url": "https://api.github.com/repos/octocat/Hello\-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" \& } \& } .Ve .RE .SS "get" .IX Subsection "get" .IP "\(bu" 4 Get a Tag .Sp .Vb 1 \& GET /repos/:user/:repo/git/tags/: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 .RE .RS 4 .Sp Examples: .Sp .Vb 6 \& my $t = Pithub::GitData::Tags\->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 \& { \& "tag": "v0.0.1", \& "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", \& "url": "https://api.github.com/repos/octocat/Hello\-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", \& "message": "initial version\en", \& "tagger": { \& "name": "Scott Chacon", \& "email": "schacon@gmail.com", \& "date": "2011\-06\-17T14:53:35\-07:00" \& }, \& "object": { \& "type": "commit", \& "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", \& "url": "https://api.github.com/repos/octocat/Hello\-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" \& } \& } .Ve .RE .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.