See https://developer.github.com/v3/
Base URL: https://api.github.com
Contact: Michael Bryzek mbryzek@alum.mit.edu http://twitter.com/mbryzek
License: MIT
blob
Path: /repos/:owner/:repo/git/blobs
GET
/repos/:owner/:repo/git/blobs/:sha Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
| sha required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | blob | |
| 404 | unit |
POST
/repos/:owner/:repo/git/blobs Body
Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 201 | blob_created | |
| 404 | unit | |
| 422 | unprocessable_entity |
commit
Path: /repos/:owner/:repo/git/commits
GET
/repos/:owner/:repo/git/commits/:sha Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
| sha required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | commit | |
| 404 | unit | |
| 422 | unprocessable_entity |
POST
/repos/:owner/:repo/git/commits Body
Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 201 | commit_response | |
| 404 | unit | |
| 422 | unprocessable_entity |
contents
Path: /repos/:owner/:repo
GET
/repos/:owner/:repo/readme Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
| ref required | string | Query default: master |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | contents | |
| 401 | unit | |
| 404 | unit |
GET
/repos/:owner/:repo/contents/:path Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
| path required | string | Path |
| ref required | string | Query default: master |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | contents | |
| 401 | unit | |
| 404 | unit |
hook
Path: /repos/:owner/:repo/hooks
GET
/repos/:owner/:repo/hooks Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | [hook] | |
| 404 | unit |
GET
/repos/:owner/:repo/hooks/:id Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
| id required | long | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | hook | |
| 404 | unit |
POST
/repos/:owner/:repo/hooks Body
Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 201 | hook | |
| 404 | unit | |
| 422 | unprocessable_entity |
DELETE
/repos/:owner/:repo/hooks/:id Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
| id required | long | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 204 | unit | |
| 404 | unit |
pull_request
Path: /repos/:owner/:repo/pulls
POST
/repos/:owner/:repo/pulls Body
Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 201 | pull_request | |
| 404 | unit | |
| 422 | unprocessable_entity |
GET
/repos/:owner/:repo/pulls Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
| page required | long | Query default: 1 |
| base | string | Query |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | [pull_request] | |
| 404 | unit |
ref
Path: /repos/:owner/:repo/git/refs
GET
/repos/:owner/:repo/git/refs Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | [ref] | |
| 404 | unit |
GET
/repos/:owner/:repo/git/refs/:ref Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
| ref required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | ref | |
| 404 | unit |
POST
/repos/:owner/:repo/git/refs Body
Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 201 | ref | |
| 404 | unit | |
| 422 | unprocessable_entity |
PUT
/repos/:owner/:repo/git/refs/:ref Body
Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
| ref required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 201 | ref | |
| 404 | unit | |
| 422 | unprocessable_entity |
repository
GET
/user/repos Parameters
| Name | Type | Description |
|---|---|---|
| page required | long | Query default: 1 |
| visibility required | visibility | Query default: all |
| affiliation | string | Query |
| type | string | Query |
| sort required | string | Query default: full_name |
| direction required | string | Query default: asc |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | [repository] | |
| 401 | unit |
GET
/users/:username/repos List public repositories for the specified user.
Parameters
| Name | Type | Description |
|---|---|---|
| username required | string | Path |
| page required | long | Query default: 1 |
| type required | string | Query default: owner |
| sort required | string | Query default: full_name |
| direction required | string | Query default: asc |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | [repository] | |
| 401 | unit |
GET
/orgs/:org/repos List repositories for the specified org.
Parameters
| Name | Type | Description |
|---|---|---|
| org required | string | Path |
| page required | long | Query default: 1 |
| type required | string | Query default: all |
| sort required | string | Query default: full_name |
| direction required | string | Query default: asc |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | [repository] | |
| 401 | unit |
tag
Path: /repos/:owner/:repo
GET
/repos/:owner/:repo/tags Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | [tag_summary] | |
| 404 | unit |
GET
/repos/:owner/:repo/tags/:sha Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
| sha required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | tag | |
| 404 | unit |
POST
/repos/:owner/:repo/git/tags Body
Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 201 | tag | |
| 404 | unit | |
| 422 | unprocessable_entity |
tree
Path: /repos/:owner/:repo/git/trees
POST
/repos/:owner/:repo/git/trees Body
Parameters
| Name | Type | Description |
|---|---|---|
| owner required | string | Path |
| repo required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 201 | create_tree_response | |
| 404 | unit | |
| 422 | unprocessable_entity |
user
GET
/user Responses
| Code | Type | Description |
|---|---|---|
| 200 | user | |
| 401 | unit |