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::GITDATA::REFERENCES (3)

.ds Aq ’

NAME

Pithub::GitData::References - Github v3 Git Data References API

CONTENTS

VERSION

version 0.01033

METHODS

    create

o Create a Reference



    POST /repos/:user/:repo/git/refs



Parameters:
o <B>userB>: mandatory string
o <B>repoB>: mandatory string
o <B>dataB>: mandatory hashref, having following keys:
o <B>refB>: mandatory string of the name of the fully qualified reference (ie: refs/heads/master). If it doesn’t start with ’refs’ and have at least two slashes, it will be rejected.
o <B>shaB>: mandatory string of the SHA1 value to set this reference to.

Examples:



    my $r = Pithub::GitData::References->new;
    my $result = $r->create(
        user => plu,
        repo => Pithub,
        data => {
            ref => refs/heads/master,
            sha => 827efc6d56897b048c772eb4087f854f46256132 .
        }
    );



    get

o Get a Reference



    GET /repos/:user/:repo/git/refs/:ref



Parameters:
o <B>userB>: mandatory string
o <B>repoB>: mandatory string
o <B>refB>: mandatory string

The key <B>refB> must be formatted as heads/branch, not just branch. For example, the call to get the data for a branch named sc/featureA would be: heads/sc/featureA

Examples:



    my $r = Pithub::GitData::References->new;
    my $result = $r->get(
        user => plu,
        repo => Pithub,
        ref  => heads/master
    );



Response: <B>Status: 200 OKB>



    {
        "ref": "refs/heads/sc/featureA",
        "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/sc/featureA",
        "object": {
            "type": "commit",
            "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
            "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd"
        }
    }



    list

o Get all References



    GET /repos/:user/:repo/git/refs



This will return an array of all the references on the system, including things like notes and stashes if they exist on the server. Anything in the namespace, not just heads and tags, though that would be the most common.

Parameters:
o <B>userB>: mandatory string
o <B>repoB>: mandatory string

Examples:



    my $r = Pithub::GitData::References->new;
    my $result = $r->list(
        user => plu,
        repo => Pithub,
    );



o You can also request a sub-namespace. For example, to get all the tag references, you can call:



    GET /repos/:user/:repo/git/refs/tags



Parameters:
o <B>userB>: mandatory string
o <B>repoB>: mandatory string
o <B>refB>: mandatory string

Examples:



    my $r = Pithub::GitData::References->new;
    my $result = $r->list(
        user => plu,
        repo => Pithub,
        ref  => tags,
    );



Response: <B>Status: 200 OKB>



    [
        {
            "object": {
                "type": "commit",
                "sha": "1c5230f42d6d3e376162591f223fc4130d671937",
                "url": "https://api.github.com/repos/plu/Pithub/git/commits/1c5230f42d6d3e376162591f223fc4130d671937"
            },
            "ref": "refs/tags/v0.01000",
            "url": "https://api.github.com/repos/plu/Pithub/git/refs/tags/v0.01000"
        },
        {
            "object": {
                "type": "tag",
                "sha": "ef328a0679a992bd2c0ac537cf19d379f1c8d177",
                "url": "https://api.github.com/repos/plu/Pithub/git/tags/ef328a0679a992bd2c0ac537cf19d379f1c8d177"
            },
            "ref": "refs/tags/v0.01001",
            "url": "https://api.github.com/repos/plu/Pithub/git/refs/tags/v0.01001"
        }
    ]



    update

o Update a Reference



    PATCH /repos/:user/:repo/git/refs/:ref



Parameters:
o <B>userB>: mandatory string
o <B>repoB>: mandatory string
o <B>refB>: mandatory string
o <B>dataB>: mandatory hashref, having following keys:
o <B>shaB>: mandatory string of the SHA1 value to set this reference to.
o <B>forceB>: optional boolean indicating whether to force the update or to make sure the update is a fast-forward update. The default is false so leaving this out or setting it to false will make sure you’re not overwriting work.

Examples:



    my $r = Pithub::GitData::References->new;
    my $result = $r->update(
        user => plu,
        repo => Pithub,
        ref  => tags/v1.0,
        data => {
            force => 1,
            sha   => aa218f56b14c9653891f9e74264a383fa43fefbd,
        }
    );



Response: <B>Status: 200 OKB>



    [
        {
            "ref": "refs/heads/sc/featureA",
            "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/sc/featureA",
            "object": {
                "type": "commit",
                "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
                "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd"
            }
        }
    ]



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::GITDATA::REFERENCES (3) 2016-01-22

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