NAME

Pithub::PullRequests::Comments - Github v3 Pull Request Comments API

VERSION

version 0.01037

METHODS

create

• Create a comment

  
              
  
                
                
  POST /repos/:user/:repo/pulls/:id/comments
              
            

  Examples:

  
              
  
                
                
  my $c = Pithub::PullRequests::Comments->new;
  my $result = $c->create(
      repo            => 'Pithub',
      user            => 'plu',
      pull_request_id => 1,
      data            => {
          body      => 'Nice change',
          commit_id => '6dcb09b5b57875f334f61aebed695e2e4193db5e',
          path      => 'file1.txt',
          position  => 4,
      }
  );
              
            

delete

• Delete a comment

  
              
  
                
                
  DELETE /repos/:user/:repo/pulls/comments/:id
              
            

  Examples:

  
              
  
                
                
  my $c = Pithub::PullRequests::Comments->new;
  my $result = $c->delete(
      repo       => 'Pithub',
      user       => 'plu',
      comment_id => 1,
  );
              
            

get

• Get a single comment

  
              
  
                
                
  GET /repos/:user/:repo/pulls/comments/:id
              
            

  Examples:

  
              
  
                
                
  my $c = Pithub::PullRequests::Comments->new;
  my $result = $c->get(
      repo       => 'Pithub',
      user       => 'plu',
      comment_id => 1,
  );
              
            

list

• List comments on a pull request

  
              
  
                
                
  GET /repos/:user/:repo/pulls/:id/comments
              
            

  Examples:

  
              
  
                
                
  my $c = Pithub::PullRequests::Comments->new;
  my $result = $c->list(
      repo            => 'Pithub',
      user            => 'plu',
      pull_request_id => 1,
  );
              
            

update

• Edit a comment

  
              
  
                
                
  PATCH /repos/:user/:repo/pulls/comments/:id
              
            

  Examples:

  
              
  
                
                
  my $c = Pithub::PullRequests::Comments->new;
  my $result = $c->update(
      repo       => 'Pithub',
      user       => 'plu',
      comment_id => 1,
      data       => { body => 'some updated comment' },
  );
              
            

AUTHOR

Johannes Plunien <plu@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Johannes Plunien.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.