---
name: "Pithub::GitData::References"
section: "3pm"
platform: "linux"
package: "libpithub-perl"
version: "0.01043-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Pithub::GitData::References"
---

# Pithub::GitData::References(3pm)

Github v3 Git Data References API

## NAME

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

## VERSION

version 0.01043

## METHODS

### create

- •

  Create a Reference

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

  Parameters:

  - •

    **user**: mandatory string

  - •

    **repo**: mandatory string

  - •

    **data**: mandatory hashref, having following keys:

    - •

      **ref**: 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.

    - •

      **sha**: 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

- •

  Get a Reference

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

  Parameters:

  - •

    **user**: mandatory string

  - •

    **repo**: mandatory string

  - •

    **ref**: mandatory string

    The key **ref** 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: **Status: 200 OK**

  ```
      {
          "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

- •

  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:

  - •

    **user**: mandatory string

  - •

    **repo**: mandatory string

  Examples:

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

- •

  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:

  - •

    **user**: mandatory string

  - •

    **repo**: mandatory string

  - •

    **ref**: mandatory string

  Examples:

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

  Response: **Status: 200 OK**

  ```
      [
          {
              "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

- •

  Update a Reference

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

  Parameters:

  - •

    **user**: mandatory string

  - •

    **repo**: mandatory string

  - •

    **ref**: mandatory string

  - •

    **data**: mandatory hashref, having following keys:

    - •

      **sha**: mandatory string of the SHA1 value to set this reference to.

    - •

      **force**: 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: **Status: 200 OK**

  ```
      [
          {
              "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.