GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PITHUB::REPOS::COMMITS (3)

.ds Aq ’

NAME

Pithub::Repos::Commits - Github v3 Repo Commits API

CONTENTS

VERSION

version 0.01033

METHODS

    compare

o Compare two commits



    GET /repos/:user/:repo/compare/:base...:head



Examples:



    my $c      = Pithub::Repos::Commits->new;
    my $result = $c->compare(
        user => plu,
        repo => Pithub,
        base => v0.01008,
        head =>  master ,
    );



    create_comment

o Create a commit comment



    POST /repos/:user/:repo/commits/:sha/comments



Examples:



    my $c = Pithub::Repos::Commits->new;
    my $result = $c->create_comment(
        user => plu,
        repo => Pithub,
        sha  => df21b2660fb6,
        data => { body => some comment },
    );



    delete_comment

o Delete a commit comment



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



Examples:



    my $c = Pithub::Repos::Commits->new;
    my $result = $c->delete_comment(
        user       => plu,
        repo       => Pithub,
        comment_id => 1,
    );



    get

o Get a single commit



    GET /repos/:user/:repo/commits/:sha



Examples:



    my $c = Pithub::Repos::Commits->new;
    my $result = $c->get(
        user => plu,
        repo => Pithub,
        sha  => df21b2660fb6,
    );



    get_comment

o Get a single commit comment



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



Examples:



    my $c = Pithub::Repos::Commits->new;
    my $result = $c->get_comment(
        user       => plu,
        repo       => Pithub,
        comment_id => 1,
    );



    list

o List commits on a repository



    GET /repos/:user/:repo/commits



Examples:



    my $c = Pithub::Repos::Commits->new;
    my $result = $c->list(
        user => plu,
        repo => Pithub,
    );



    list_comments

o List commit comments for a repository

Commit Comments leverage these custom mime types. You can read more about the use of mimes types in the API here. See also: <http://developer.github.com/v3/mimes/>.



    GET /repos/:user/:repo/comments



Examples:



    my $c = Pithub::Repos::Commits->new;
    my $result = $c->list_comments(
        user => plu,
        repo => Pithub,
    );



o List comments for a single commit



    GET /repos/:user/:repo/commits/:sha/comments



Examples:



    my $c = Pithub::Repos::Commits->new;
    my $result = $c->list_comments(
        user => plu,
        repo => Pithub,
        sha  => df21b2660fb6,
    );



    update_comment

o Update a commit comment



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



Examples:



    my $c = Pithub::Repos::Commits->new;
    my $result = $c->update_comment(
        user       => plu,
        repo       => Pithub,
        comment_id => 1,
        data       => { body => 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.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PITHUB::REPOS::COMMITS (3) 2016-01-22

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.