.\" 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::Issues::Labels 3pm" .TH Pithub::Issues::Labels 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::Issues::Labels \- Github v3 Issue Labels API .SH "VERSION" .IX Header "VERSION" version 0.01041 .SH "METHODS" .IX Header "METHODS" .SS "add" .IX Subsection "add" .IP "\(bu" 4 Add labels to an issue .Sp .Vb 1 \& POST /repos/:user/:repo/issues/:id/labels .Ve .Sp Examples: .Sp .Vb 7 \& my $l = Pithub::Issues::Labels\->new; \& my $result = $l\->add( \& repo => \*(AqPithub\*(Aq, \& user => \*(Aqplu\*(Aq, \& issue_id => 1, \& data => [\*(AqLabel1\*(Aq, \*(AqLabel2\*(Aq], \& ); .Ve .SS "create" .IX Subsection "create" .IP "\(bu" 4 Create a label .Sp .Vb 1 \& POST /repos/:user/:repo/labels .Ve .Sp Examples: .Sp .Vb 9 \& my $l = Pithub::Issues::Labels\->new; \& my $result = $l\->create( \& repo => \*(AqPithub\*(Aq, \& user => \*(Aqplu\*(Aq, \& data => { \& color => \*(AqFFFFFF\*(Aq, \& name => \*(Aqsome label\*(Aq, \& } \& ); .Ve .SS "delete" .IX Subsection "delete" .IP "\(bu" 4 Delete a label .Sp .Vb 1 \& DELETE /repos/:user/:repo/labels/:id .Ve .Sp Examples: .Sp .Vb 6 \& my $l = Pithub::Issues::Labels\->new; \& my $result = $l\->delete( \& repo => \*(AqPithub\*(Aq, \& user => \*(Aqplu\*(Aq, \& label => 1, \& ); .Ve .SS "get" .IX Subsection "get" .IP "\(bu" 4 Get a single label .Sp .Vb 1 \& GET /repos/:user/:repo/labels/:id .Ve .Sp Examples: .Sp .Vb 6 \& my $l = Pithub::Issues::Labels\->new; \& my $result = $l\->get( \& repo => \*(AqPithub\*(Aq, \& user => \*(Aqplu\*(Aq, \& label => 1, \& ); .Ve .SS "list" .IX Subsection "list" .IP "\(bu" 4 List all labels for this repository .Sp .Vb 1 \& GET /repos/:user/:repo/labels .Ve .Sp Examples: .Sp .Vb 5 \& my $l = Pithub::Issues::Labels\->new; \& my $result = $l\->list( \& repo => \*(AqPithub\*(Aq, \& user => \*(Aqplu\*(Aq \& ); .Ve .IP "\(bu" 4 List labels on an issue .Sp .Vb 1 \& GET /repos/:user/:repo/issues/:id/labels .Ve .Sp Examples: .Sp .Vb 6 \& my $l = Pithub::Issues::Labels\->new; \& my $result = $l\->list( \& repo => \*(AqPithub\*(Aq, \& user => \*(Aqplu\*(Aq, \& issue_id => 1, \& ); .Ve .IP "\(bu" 4 Get labels for every issue in a milestone .Sp .Vb 1 \& GET /repos/:user/:repo/milestones/:id/labels .Ve .Sp Examples: .Sp .Vb 6 \& my $l = Pithub::Issues::Labels\->new; \& my $result = $l\->get( \& repo => \*(AqPithub\*(Aq, \& user => \*(Aqplu\*(Aq, \& milestone_id => 1 \& ); .Ve .SS "remove" .IX Subsection "remove" .IP "\(bu" 4 Remove a label from an issue .Sp .Vb 1 \& DELETE /repos/:user/:repo/issues/:id/labels/:id .Ve .Sp Examples: .Sp .Vb 7 \& my $l = Pithub::Issues::Labels\->new; \& my $result = $l\->delete( \& repo => \*(AqPithub\*(Aq, \& user => \*(Aqplu\*(Aq, \& issue_id => 1, \& label => 1, \& ); .Ve .IP "\(bu" 4 Remove all labels from an issue .Sp .Vb 1 \& DELETE /repos/:user/:repo/issues/:id/labels .Ve .Sp Examples: .Sp .Vb 6 \& my $l = Pithub::Issues::Labels\->new; \& my $result = $l\->delete( \& repo => \*(AqPithub\*(Aq, \& user => \*(Aqplu\*(Aq, \& issue_id => 1, \& ); .Ve .SS "replace" .IX Subsection "replace" .IP "\(bu" 4 Replace all labels for an issue .Sp .Vb 1 \& PUT /repos/:user/:repo/issues/:id/labels .Ve .Sp Examples: .Sp .Vb 7 \& my $l = Pithub::Issues::Labels\->new; \& my $result = $l\->replace( \& repo => \*(AqPithub\*(Aq, \& user => \*(Aqplu\*(Aq, \& issue_id => 1, \& data => [qw(label3 label4)], \& ); .Ve .SS "update" .IX Subsection "update" .IP "\(bu" 4 Update a label .Sp .Vb 1 \& PATCH /repos/:user/:repo/labels/:id .Ve .Sp Examples: .Sp .Vb 10 \& my $l = Pithub::Issues::Labels\->new; \& my $result = $l\->update( \& repo => \*(AqPithub\*(Aq, \& user => \*(Aqplu\*(Aq, \& label => 1, \& data => { \& color => \*(AqFFFFFF\*(Aq, \& name => \*(AqAPI\*(Aq, \& } \& ); .Ve .SH "AUTHOR" .IX Header "AUTHOR" Johannes Plunien .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.