API-CLI
view release on metacpan or search on metacpan
examples/githubcl-openapi.yaml view on Meta::CPAN
# this is a copy of https://github.com/APIs-guru/api-models/blob/master/APIs/github.com/v3/swagger.yaml
swagger: '2.0'
schemes:
- https
host: api.github.com
basePath: /
x-hasEquivalentPaths: true
info:
description: |
Powerful collaboration, code review, and code management for open source and private projects.
termsOfService: 'https://help.github.com/articles/github-terms-of-service/#b-api-terms'
title: GitHub
version: v3
x-logo:
url: 'http://assets-cdn.github.com/images/modules/logos_page/GitHub-Mark.png'
x-origin:
format: swagger
url: 'https://raw.githubusercontent.com/APIs-guru/unofficial_openapi_specs/master/github.com/v3/swagger.yaml'
version: '2.0'
x-providerName: github.com
x-unofficialSpec: true
externalDocs:
url: 'https://developer.github.com/v3/'
consumes:
- application/json
produces:
- application/json
securityDefinitions:
oauth_2_0:
authorizationUrl: 'https://github.com/login/oauth/authorize'
description: |
OAuth2 is a protocol that lets external apps request authorization to private
details in a user's GitHub account without getting their password. This is
preferred over Basic Authentication because tokens can be limited to specific
types of data, and can be revoked by users at any time.
flow: accessCode
scopes:
'admin:org': ''
'admin:org_hook': ''
'admin:public_key': ''
'admin:repo_hook': ''
delete_repo: ''
gist: ''
notifications: ''
public_repo: ''
'read:org': ''
'read:public_key': ''
'read:repo_hook': ''
repo: ''
'repo:status': ''
repo_deployment: ''
user: ''
'user:email': ''
'user:follow': ''
'write:org': ''
'write:public_key': ''
'write:repo_hook': ''
tokenUrl: 'https://github.com/login/oauth/access_token'
type: oauth2
paths:
/emojis:
get:
description: Lists all the emojis available to use on GitHub.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/emojis'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/events:
get:
description: List public events.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/events'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/feeds:
get:
description: |
List Feeds.
GitHub provides several timeline resources in Atom format. The Feeds API
lists all the feeds available to the authenticating user.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/feeds'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/gists:
get:
description: |
List the authenticated user's gists or if called anonymously, this will
return all public gists.
parameters:
- description: |
Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.
Only gists updated at or after this time are returned.
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gists'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a gist.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/postGist'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/gist'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/gists/public:
get:
description: List all public gists.
parameters:
- description: |
Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.
Only gists updated at or after this time are returned.
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gists'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/gists/starred:
get:
description: List the authenticated user's starred gists.
parameters:
- description: |
Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.
Only gists updated at or after this time are returned.
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gists'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/gists/{id}':
delete:
description: Delete a gist.
parameters:
- description: Id of gist.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get a single gist.
parameters:
- description: Id of gist.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gist'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Edit a gist.
parameters:
- description: Id of gist.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/patchGist'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gist'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/gists/{id}/comments':
get:
description: List comments on a gist.
parameters:
- description: Id of gist.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/comments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a commen
parameters:
- description: Id of gist.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/commentBody'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/comment'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/gists/{id}/comments/{commentId}':
delete:
description: Delete a comment.
parameters:
- description: Id of gist.
in: path
name: id
required: true
type: integer
- description: Id of comment.
in: path
name: commentId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get a single comment.
parameters:
- description: Id of gist.
in: path
name: id
required: true
type: integer
- description: Id of comment.
in: path
name: commentId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/comment'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Edit a comment.
parameters:
- description: Id of gist.
in: path
name: id
required: true
type: integer
- description: Id of comment.
in: path
name: commentId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/comment'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/comment'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/gists/{id}/forks':
post:
description: Fork a gist.
parameters:
- description: Id of gist.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Exists.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: Not exists.
'/gists/{id}/star':
delete:
description: Unstar a gist.
parameters:
- description: Id of gist.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Item removed.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Check if a gist is starred.
parameters:
- description: Id of gist.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Exists.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: Not exists.
put:
description: Star a gist.
parameters:
- description: Id of gist.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Starred.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/gitignore/templates:
get:
description: |
Listing available templates.
List all templates available to pass as an option when creating a repository.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gitignore'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/gitignore/templates/{language}':
get:
description: Get a single template.
parameters:
- in: path
name: language
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gitignore-lang'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/issues:
get:
description: |
List issues.
List all issues across all the authenticated user's visible repositories.
parameters:
- default: all
description: |
Issues assigned to you / created by you / mentioning you / you're
subscribed to updates for / All issues the authenticated user can see
enum:
- assigned
- created
- mentioned
- subscribed
- all
in: query
name: filter
required: true
type: string
- default: open
enum:
- open
- closed
in: query
name: state
required: true
type: string
- description: 'String list of comma separated Label names. Example - bug,ui,@high.'
in: query
name: labels
required: true
type: string
- default: created
enum:
- created
- updated
- comments
in: query
name: sort
required: true
type: string
- default: desc
enum:
- asc
- desc
in: query
name: direction
required: true
type: string
- description: |
Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only issues updated at or after this time are returned.
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/issues'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/legacy/issues/search/{owner}/{repository}/{state}/{keyword}':
get:
description: Find issues by state and keyword.
parameters:
- description: The search term.
in: path
name: keyword
required: true
type: string
- description: Indicates the state of the issues to return. Can be either open or closed.
enum:
- open
- closed
in: path
name: state
required: true
type: string
- in: path
name: owner
required: true
type: string
- in: path
name: repository
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/search-issues-by-keyword'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/legacy/repos/search/{keyword}':
get:
description: 'Find repositories by keyword. Note, this legacy method does not follow the v3 pagination pattern. This method returns up to 100 results per page and pages can be fetched using the start_page parameter.'
parameters:
- description: The search term
in: path
name: keyword
required: true
type: string
- default: desc
description: The sort field. if sort param is provided. Can be either asc or desc.
enum:
- desc
- asc
in: query
name: order
type: string
- description: Filter results by language
in: query
name: language
type: string
- description: The page number to fetch
in: query
name: start_page
type: string
- description: 'The sort field. One of stars, forks, or updated. Default: results are sorted by best match.'
enum:
- updated
- stars
- forks
in: query
name: sort
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/search-repositories-by-keyword'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/legacy/user/email/{email}':
get:
description: This API call is added for compatibility reasons only.
parameters:
- description: The email address
in: path
name: email
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/search-user-by-email'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/legacy/user/search/{keyword}':
get:
description: Find users by keyword.
parameters:
- description: The search term
in: path
name: keyword
required: true
type: string
- default: desc
description: The sort field. if sort param is provided. Can be either asc or desc.
enum:
- desc
- asc
in: query
name: order
type: string
- description: The page number to fetch
in: query
name: start_page
type: string
- description: 'The sort field. One of stars, forks, or updated. Default: results are sorted by best match.'
enum:
- updated
- stars
- forks
in: query
name: sort
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/search-users-by-keyword'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/markdown:
post:
description: Render an arbitrary Markdown document
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/markdown'
produces:
- text/html
responses:
'200':
description: OK
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/markdown/raw:
post:
consumes:
- text/plain
description: Render a Markdown document in raw mode
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
produces:
- text/html
responses:
'200':
description: OK
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/meta:
get:
description: 'This gives some information about GitHub.com, the service.'
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/meta'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/networks/{owner}/{repo}/events':
get:
description: List public events for a network of repositories.
parameters:
- description: Name of the owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/events'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/notifications:
get:
description: |
List your notifications.
List all notifications for the current user, grouped by repository.
parameters:
- description: True to show notifications marked as read.
in: query
name: all
type: boolean
- description: |
True to show only notifications in which the user is directly participating
or mentioned.
in: query
name: participating
type: boolean
- description: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/notifications'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
put:
description: |
Mark as read.
Marking a notification as "read" removes it from the default view on GitHub.com.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/notificationMarkRead'
responses:
'205':
description: Marked as read.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/notifications/threads/{id}':
get:
description: View a single thread.
parameters:
- description: Id of thread.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/notifications'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Mark a thread as read
parameters:
- description: Id of thread.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'205':
description: Thread marked as read.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/notifications/threads/{id}/subscription':
delete:
description: Delete a Thread Subscription.
parameters:
- description: Id of thread.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No Content
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get a Thread Subscription.
parameters:
- description: Id of thread.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/subscription'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
put:
description: |
Set a Thread Subscription.
This lets you subscribe to a thread, or ignore it. Subscribing to a thread
is unnecessary if the user is already subscribed to the repository. Ignoring
a thread will mute all future notifications (until you comment or get @mentioned).
parameters:
- description: Id of thread.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/putSubscription'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/subscription'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/orgs/{org}':
get:
description: Get an Organization.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/organization'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Edit an Organization.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/patchOrg'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/organization'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/orgs/{org}/events':
get:
description: List public events for an organization.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/events'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/orgs/{org}/issues':
get:
description: |
List issues.
List all issues for a given organization for the authenticated user.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- default: all
description: |
Issues assigned to you / created by you / mentioning you / you're
subscribed to updates for / All issues the authenticated user can see
enum:
- assigned
- created
- mentioned
- subscribed
- all
in: query
name: filter
required: true
type: string
- default: open
enum:
- open
- closed
in: query
name: state
required: true
type: string
- description: 'String list of comma separated Label names. Example - bug,ui,@high.'
in: query
name: labels
required: true
type: string
- default: created
enum:
- created
- updated
- comments
in: query
name: sort
required: true
type: string
- default: desc
enum:
- asc
- desc
in: query
name: direction
required: true
type: string
- description: |
Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only issues updated at or after this time are returned.
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/issues'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/orgs/{org}/members':
get:
description: |
Members list.
List all users who are members of an organization. A member is a user tha
belongs to at least 1 team in the organization. If the authenticated user
is also an owner of this organization then both concealed and public members
will be returned. If the requester is not an owner of the organization the
query will be redirected to the public members list.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'302':
description: Response if requester is not an organization member.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/orgs/{org}/members/{username}':
delete:
description: |
Remove a member.
Removing a user from this list will remove them from all teams and they
will no longer have any access to the organization's repositories.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: Name of the user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: 'Check if a user is, publicly or privately, a member of the organization.'
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: Name of the user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content. Response if requester is an organization member and user is a member
'302':
description: |
Found. Response if requester is not an organization member
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: |
Not Found.
a. Response if requester is an organization member and user is not a member
b. Response if requester is not an organization member and is inquiring about themselves
'/orgs/{org}/public_members':
get:
description: |
Public members list.
Members of an organization can choose to have their membership publicized
or not.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/orgs/{org}/public_members/{username}':
delete:
description: Conceal a user's membership.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: Name of the user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Concealed.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Check public membership.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: Name of the user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: User is a public member.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: User is not a public member.
put:
description: Publicize a user's membership.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: Name of the user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Publicized.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/orgs/{org}/repos':
get:
description: List repositories for the specified org.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- default: all
enum:
- all
- public
- private
- forks
- sources
- member
in: query
name: type
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repos'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a new repository for the authenticated user. OAuth users must supply
repo scope.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/postRepo'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/repos'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/orgs/{org}/teams':
get:
description: List teams.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/teams'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create team.
In order to create a team, the authenticated user must be an owner of organization.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/orgTeamsPost'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/team'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/rate_limit:
get:
description: |
Get your current rate limit status
Note: Accessing this endpoint does not count against your rate limit.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/rate_limit'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}':
delete:
description: |
Delete a Repository.
Deleting a repository requires admin access. If OAuth is used, the delete_repo
scope is required.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Item removed.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repo'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Edit repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/repoEdit'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repo'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/assignees':
get:
description: |
List assignees.
This call lists all the available assignees (owner + collaborators) to which
issues may be assigned.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/assignees'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/assignees/{assignee}':
get:
description: |
Check assignee.
You may also check to see if a particular user is an assignee for a repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Login of the assignee.
in: path
name: assignee
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: User is an assignee.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: User isn't an assignee.
'/repos/{owner}/{repo}/branches':
get:
description: Get list of branches
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/branches'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/branches/{branch}':
get:
description: Get Branch
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Name of the branch.
in: path
name: branch
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/branch'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/collaborators':
get:
description: |
List.
When authenticating as an organization owner of an organization-owned
repository, all organization owners are included in the list of
collaborators. Otherwise, only users with access to the repository are
returned in the collaborators list.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/collaborators/{user}':
delete:
description: Remove collaborator.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Login of the user.
in: path
name: user
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Collaborator removed.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Check if user is a collaborator
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Login of the user.
in: path
name: user
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: User is a collaborator.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: User is not a collaborator.
put:
description: Add collaborator.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Login of the user.
in: path
name: user
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Collaborator added.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/comments':
get:
description: |
List commit comments for a repository.
Comments are ordered by ascending ID.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repoComments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/comments/{commentId}':
delete:
description: Delete a commit comment
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of comment.
in: path
name: commentId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get a single commit comment.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of comment.
in: path
name: commentId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/commitComments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Update a commit comment.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of comment.
in: path
name: commentId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/commentBody'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/commitComments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/commits':
get:
description: List commits on a repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
in: query
name: since
type: string
- description: Sha or branch to start listing commits from.
in: query
name: sha
type: string
- description: Only commits containing this file path will be returned.
in: query
name: path
type: string
- description: 'GitHub login, name, or email by which to filter by commit author.'
in: query
name: author
type: string
- description: ISO 8601 Date - Only commits before this date will be returned.
in: query
name: until
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/commits'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/commits/{ref}/status':
get:
description: |
Get the combined Status for a specific Ref
The Combined status endpoint is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details.
To access this endpoint during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.she-hulk-preview+json
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: ref
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/refStatus'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/commits/{shaCode}':
get:
description: Get a single commit.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: SHA-1 code of the commit.
in: path
name: shaCode
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/commit'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/commits/{shaCode}/comments':
get:
description: List comments for a single commitList comments for a single commit.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: SHA-1 code of the commit.
in: path
name: shaCode
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repoComments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a commit comment.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: SHA-1 code of the commit.
in: path
name: shaCode
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/commitBody'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/commitComments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/compare/{baseId}...{headId}':
get:
description: Compare two commits
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: baseId
required: true
type: string
- in: path
name: headId
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/compare-commits'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/contents/{path}':
delete:
description: |
Delete a file.
This method deletes a file in a repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: path
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/deleteFileBody'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/deleteFile'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: |
Get contents.
This method returns the contents of a file or directory in a repository.
Files and symlinks support a custom media type for getting the raw content.
Directories and submodules do not support custom media types.
Note: This API supports files up to 1 megabyte in size.
Here can be many outcomes. For details see "http://developer.github.com/v3/repos/contents/"
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: path
required: true
type: string
- description: The content path.
in: query
name: path
type: string
- description: The String name of the Commit/Branch/Tag. Defaults to 'master'.
in: query
name: ref
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/contents-path'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
put:
description: Create a file.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: path
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/createFileBody'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/createFile'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/contributors':
get:
description: Get list of contributors.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Set to 1 or true to include anonymous contributors in results.
in: query
name: anon
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/contributors'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/deployments':
get:
description: Users with pull access can view deployments for a repository
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repo-deployments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Users with push access can create a deployment for a given ref
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/deployment'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/deployment-resp'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/deployments/{id}/statuses':
get:
description: Users with pull access can view deployment statuses for a deployment
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: The Deployment ID to list the statuses from.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/deployment-statuses'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a Deployment Status
Users with push access can create deployment statuses for a given deployment:
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: The Deployment ID to list the statuses from.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/deployment-statuses-create'
responses:
'201':
description: ok
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/downloads':
get:
description: Deprecated. List downloads for a repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/downloads'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/downloads/{downloadId}':
delete:
description: Deprecated. Delete a download.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of download.
in: path
name: downloadId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Deprecated. Get a single download.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of download.
in: path
name: downloadId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/downloads'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/events':
get:
description: Get list of repository events.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/events'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/forks':
get:
description: List forks.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- default: newes
enum:
- newes
- oldes
- watchers
in: query
name: sort
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/forks'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a fork.
Forking a Repository happens asynchronously. Therefore, you may have to wai
a short period before accessing the git objects. If this takes longer than 5
minutes, be sure to contact Support.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/forkBody'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/fork'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/git/blobs':
post:
description: Create a Blob.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/blob'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/blobs'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/git/blobs/{shaCode}':
get:
description: |
Get a Blob.
Since blobs can be any arbitrary binary data, the input and responses for
the blob API takes an encoding parameter that can be either utf-8 or
base64. If your data cannot be losslessly sent as a UTF-8 string, you can
base64 encode it.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: SHA-1 code.
in: path
name: shaCode
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/blob'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/git/commits':
post:
description: Create a Commit.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/repoCommitBody'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/gitCommit'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/git/commits/{shaCode}':
get:
description: Get a Commit.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: SHA-1 code.
in: path
name: shaCode
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repoCommit'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/git/refs':
get:
description: Get all References
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/refs'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a Reference
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/refsBody'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/headBranch'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/git/refs/{ref}':
delete:
description: |
Delete a Reference
Example: Deleting a branch: DELETE /repos/octocat/Hello-World/git/refs/heads/feature-a
Example: Deleting a tag: DELETE /repos/octocat/Hello-World/git/refs/tags/v1.0
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: ref
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: No Content
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get a Reference
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: ref
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/headBranch'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Update a Reference
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: ref
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/gitRefPatch'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/headBranch'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/git/tags':
post:
description: |
Create a Tag Object.
Note that creating a tag object does not create the reference that makes a
tag in Git. If you want to create an annotated tag in Git, you have to do
this call to create the tag object, and then create the refs/tags/[tag]
reference. If you want to create a lightweight tag, you only have to create
the tag reference - this call would be unnecessary.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/tag'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/tags'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/git/tags/{shaCode}':
get:
description: Get a Tag.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: shaCode
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/tag'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/git/trees':
post:
description: |
Create a Tree.
The tree creation API will take nested entries as well. If both a tree and
a nested path modifying that tree are specified, it will overwrite the
contents of that tree with the new path contents and write a new tree out.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/tree'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/trees'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/git/trees/{shaCode}':
get:
description: Get a Tree.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Tree SHA.
in: path
name: shaCode
required: true
type: string
- description: Get a Tree Recursively. (0 or 1)
in: query
name: recursive
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/tree'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/hooks':
get:
description: Get list of hooks.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/hook'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a hook.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/hookBody'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/hook'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/hooks/{hookId}':
delete:
description: Delete a hook.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of hook.
in: path
name: hookId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get single hook.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of hook.
in: path
name: hookId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/hook'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Edit a hook.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of hook.
in: path
name: hookId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/hookBody'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/hook'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/hooks/{hookId}/tests':
post:
description: |
Test a push hook.
This will trigger the hook with the latest push to the current repository
if the hook is subscribed to push events. If the hook is not subscribed
to push events, the server will respond with 204 but no test POST will
be generated.
Note: Previously /repos/:owner/:repo/hooks/:id/tes
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of hook.
in: path
name: hookId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Hook is triggered.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/issues':
get:
description: List issues for a repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- default: all
description: |
Issues assigned to you / created by you / mentioning you / you're
subscribed to updates for / All issues the authenticated user can see
enum:
- assigned
- created
- mentioned
- subscribed
- all
in: query
name: filter
required: true
type: string
- default: open
enum:
- open
- closed
in: query
name: state
required: true
type: string
- description: 'String list of comma separated Label names. Example - bug,ui,@high.'
in: query
name: labels
required: true
type: string
- default: created
enum:
- created
- updated
- comments
in: query
name: sort
required: true
type: string
- default: desc
enum:
- asc
- desc
in: query
name: direction
required: true
type: string
- description: |
Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only issues updated at or after this time are returned.
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/issues'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create an issue.
Any user with pull access to a repository can create an issue.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/issue'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/issue'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/issues/comments':
get:
description: List comments in a repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Ignored without 'sort' parameter.
in: query
name: direction
type: string
- description: ''
enum:
- created
- updated
in: query
name: sort
type: string
- description: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/issuesComments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/issues/comments/{commentId}':
delete:
description: Delete a comment.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: ID of comment.
in: path
name: commentId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get a single comment.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: ID of comment.
in: path
name: commentId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/issuesComment'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Edit a comment.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: ID of comment.
in: path
name: commentId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/commentBody'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/issuesComment'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/issues/events':
get:
description: List issue events for a repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/events'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/issues/events/{eventId}':
get:
description: Get a single event.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of the event.
in: path
name: eventId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/event'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/issues/{number}':
get:
description: Get a single issue
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Number of issue.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/issue'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: |
Edit an issue.
Issue owners and users with push access can edit an issue.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Number of issue.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/issue'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/issue'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/issues/{number}/comments':
get:
description: List comments on an issue.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Number of issue.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/issuesComments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a comment.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Number of issue.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/commentBody'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/issuesComment'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/issues/{number}/events':
get:
description: List events for an issue.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Number of issue.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/events'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/issues/{number}/labels':
delete:
description: Remove all labels from an issue.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Number of issue.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: List labels on an issue.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Number of issue.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/labels'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Add labels to an issue.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Number of issue.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/emailsPost'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/label'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
put:
description: |
Replace all labels for an issue.
Sending an empty array ([]) will remove all Labels from the Issue.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Number of issue.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/emailsPost'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/label'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/issues/{number}/labels/{name}':
delete:
description: Remove a label from an issue.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Number of issue.
in: path
name: number
required: true
type: integer
- description: Name of the label.
in: path
name: name
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Item removed.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/keys':
get:
description: Get list of keys.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/keys'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a key.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/user-keys-post'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/user-keys-keyId'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/keys/{keyId}':
delete:
description: Delete a key.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of key.
in: path
name: keyId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get a key
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of key.
in: path
name: keyId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/user-keys-keyId'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/labels':
get:
description: List all labels for this repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/labels'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a label.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/emailsPost'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/label'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/labels/{name}':
delete:
description: Delete a label.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Name of the label.
in: path
name: name
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get a single label.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Name of the label.
in: path
name: name
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/label'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Update a label.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Name of the label.
in: path
name: name
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/emailsPost'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/label'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/languages':
get:
description: |
List languages.
List languages for the specified repository. The value on the right of a
language is the number of bytes of code written in that language.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/languages'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/merges':
post:
description: Perform a merge.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/mergesBody'
responses:
'201':
description: Successful Response (The resulting merge commit)
schema:
$ref: '#/definitions/mergesSuccessful'
'204':
description: 'No-op response (base already contains the head, nothing to merge)'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: Missing base response or missing head response
schema:
$ref: '#/definitions/mergesConflict'
'409':
description: Merge conflict response.
schema:
$ref: '#/definitions/mergesConflict'
'/repos/{owner}/{repo}/milestones':
get:
description: List milestones for a repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- default: open
description: String to filter by state.
enum:
- open
- closed
in: query
name: state
type: string
- description: Ignored without 'sort' parameter.
in: query
name: direction
type: string
- default: due_date
description: ''
enum:
- due_date
- completeness
in: query
name: sort
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/milestone'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a milestone.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/milestoneUpdate'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/milestone'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/milestones/{number}':
delete:
description: Delete a milestone.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Number of milestone.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get a single milestone.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Number of milestone.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/milestone'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Update a milestone.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Number of milestone.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/milestoneUpdate'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/milestone'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/milestones/{number}/labels':
get:
description: Get labels for every issue in a milestone.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Number of milestone.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/labels'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/notifications':
get:
description: |
List your notifications in a repository
List all notifications for the current user.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: True to show notifications marked as read.
in: query
name: all
type: boolean
- description: |
True to show only notifications in which the user is directly participating
or mentioned.
in: query
name: participating
type: boolean
- description: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/notifications'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
put:
description: |
Mark notifications as read in a repository.
Marking all notifications in a repository as "read" removes them from the
default view on GitHub.com.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/notificationMarkRead'
responses:
'205':
description: Marked as read.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/pulls':
get:
description: List pull requests.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- default: open
description: String to filter by state.
enum:
- open
- closed
in: query
name: state
type: string
- description: |
Filter pulls by head user and branch name in the format of 'user:ref-name'.
Example: github:new-script-format.
in: query
name: head
type: string
- description: Filter pulls by base branch name. Example - gh-pages.
in: query
name: base
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/pulls'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a pull request.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/pullsPost'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/pulls'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/pulls/comments':
get:
description: |
List comments in a repository.
By default, Review Comments are ordered by ascending ID.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Ignored without 'sort' parameter.
in: query
name: direction
type: string
- description: ''
enum:
- created
- updated
in: query
name: sort
type: string
- description: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/issuesComments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/pulls/comments/{commentId}':
delete:
description: Delete a comment.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of comment.
in: path
name: commentId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get a single comment.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of comment.
in: path
name: commentId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/pullsComment'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Edit a comment.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of comment.
in: path
name: commentId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/commentBody'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/pullsComment'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/pulls/{number}':
get:
description: Get a single pull request.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of pull.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/pullRequest'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Update a pull request.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of pull.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/pullUpdate'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repo'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/pulls/{number}/comments':
get:
description: List comments on a pull request.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of pull.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/pullsComment'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a comment.
#TODO Alternative input ( http://developer.github.com/v3/pulls/comments/ )
description: |
Alternative Input.
Instead of passing commit_id, path, and position you can reply to an
existing Pull Request Comment like this:
body
Required string
in_reply_to
Required number - Comment id to reply to.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of pull.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/pullsCommentPost'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/pullsComment'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/pulls/{number}/commits':
get:
description: List commits on a pull request.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of pull.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/commits'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/pulls/{number}/files':
get:
description: List pull requests files.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of pull.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/pulls'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/pulls/{number}/merge':
get:
description: Get if a pull request has been merged.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of pull.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Pull request has been merged.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: Pull request has not been merged.
put:
description: Merge a pull request (Merge Button's)
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of pull.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/mergePullBody'
responses:
'200':
description: Response if merge was successful.
schema:
$ref: '#/definitions/merge'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'405':
description: Response if merge cannot be performed.
schema:
$ref: '#/definitions/merge'
'/repos/{owner}/{repo}/readme':
get:
description: |
Get the README.
This method returns the preferred README for a repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: The String name of the Commit/Branch/Tag. Defaults to master.
in: query
name: ref
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/contents-path'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/releases':
get:
description: 'Users with push access to the repository will receive all releases (i.e., published releases and draft releases). Users with pull access will receive published releases only'
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/releases'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a release
Users with push access to the repository can create a release.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/release-create'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/release'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/releases/assets/{id}':
delete:
description: Delete a release asset
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: id
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: No Content
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get a single release asset
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: id
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/asset'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: |
Edit a release asset
Users with push access to the repository can edit a release asset.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: id
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/assetPatch'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/asset'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/releases/{id}':
delete:
description: Users with push access to the repository can delete a release.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: id
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: No Content
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get a single release
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: id
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/release'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Users with push access to the repository can edit a release
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: id
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/release-create'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/release'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/releases/{id}/assets':
get:
description: List assets for a release
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: id
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/assets'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/stargazers':
get:
description: List Stargazers.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/stats/code_frequency':
get:
description: |
Get the number of additions and deletions per week.
Returns a weekly aggregate of the number of additions and deletions pushed
to a repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/codeFrequencyStats'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/stats/commit_activity':
get:
description: |
Get the last year of commit activity data.
Returns the last year of commit activity grouped by week. The days array
is a group of commits per day, starting on Sunday.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/commitActivityStats'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/stats/contributors':
get:
description: 'Get contributors list with additions, deletions, and commit counts.'
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/contributorsStats'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/stats/participation':
get:
description: Get the weekly commit count for the repo owner and everyone else.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/participationStats'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/stats/punch_card':
get:
description: |
Get the number of commits per hour in each day.
Each array contains the day number, hour number, and number of commits
0-6 Sunday - Saturday
0-23 Hour of day
Number of commits
For example, [2, 14, 25] indicates that there were 25 total commits, during
the 2.00pm hour on Tuesdays. All times are based on the time zone of
individual commits.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/codeFrequencyStats'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/statuses/{ref}':
get:
description: List Statuses for a specific Ref.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.
in: path
name: ref
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ref'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a Status.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.
in: path
name: ref
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/headBranch'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/ref'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/subscribers':
get:
description: List watchers.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/subscription':
delete:
description: Delete a Repository Subscription.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get a Repository Subscription.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/subscribition'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
put:
description: Set a Repository Subscription
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/subscribitionBody'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/subscribition'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/tags':
get:
description: Get list of tags.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/tags'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/teams':
get:
description: Get list of teams
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/teams'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/watchers':
get:
description: List Stargazers. New implementation.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/{archive_format}/{path}':
get:
description: |
Get archive link.
This method will return a 302 to a URL to download a tarball or zipball
archive for a repository. Please make sure your HTTP framework is
configured to follow redirects or you will need to use the Location header
to make a second GET request.
Note: For private repositories, these links are temporary and expire quickly.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- enum:
- tarball
- zipball
in: path
name: archive_format
required: true
type: string
- description: 'Valid Git reference, defaults to ''master''.'
in: path
name: path
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'302':
description: Found.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repositories:
get:
description: |
List all public repositories.
This provides a dump of every public repository, in the order that they
were created.
Note: Pagination is powered exclusively by the since parameter. is the
Link header to get the URL for the next page of repositories.
parameters:
- description: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repositories'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/search/code:
get:
description: Search code.
parameters:
- default: desc
description: The sort field. if sort param is provided. Can be either asc or desc.
enum:
- desc
- asc
in: query
name: order
type: string
- description: |
The search terms. This can be any combination of the supported code
search parameters:
'Search In' Qualifies which fields are searched. With this qualifier
you can restrict the search to just the file contents, the file path,
or both.
'Languages' Searches code based on the language it's written in.
'Forks' Filters repositories based on the number of forks, and/or
whether code from forked repositories should be included in the results
at all.
'Size' Finds files that match a certain size (in bytes).
'Path' Specifies the path that the resulting file must be at.
'Extension' Matches files with a certain extension.
'Users' or 'Repositories' Limits searches to a specific user or repository.
in: query
name: q
required: true
type: string
- description: |
Can only be 'indexed', which indicates how recently a file has been indexed
by the GitHub search infrastructure. If not provided, results are sorted
by best match.
enum:
- indexed
in: query
name: sort
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/search-code'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/search/issues:
get:
description: Find issues by state and keyword. (This method returns up to 100 results per page.)
parameters:
- default: desc
description: The sort field. if sort param is provided. Can be either asc or desc.
enum:
- desc
- asc
in: query
name: order
type: string
- description: 'The q search term can also contain any combination of the supported issue search qualifiers:'
in: query
name: q
required: true
type: string
- description: 'The sort field. Can be comments, created, or updated. Default: results are sorted by best match.'
enum:
- updated
- created
- comments
in: query
name: sort
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/search-issues'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/search/repositories:
get:
description: Search repositories.
parameters:
- default: desc
description: The sort field. if sort param is provided. Can be either asc or desc.
enum:
- desc
- asc
in: query
name: order
type: string
- description: |
The search terms. This can be any combination of the supported repository
search parameters:
'Search In' Qualifies which fields are searched. With this qualifier you
can restrict the search to just the repository name, description, readme,
or any combination of these.
'Size' Finds repositories that match a certain size (in kilobytes).
'Forks' Filters repositories based on the number of forks, and/or whether
forked repositories should be included in the results at all.
'Created' and 'Last Updated' Filters repositories based on times of
creation, or when they were last updated.
'Users or Repositories' Limits searches to a specific user or repository.
'Languages' Searches repositories based on the language they are written in.
'Stars' Searches repositories based on the number of stars.
in: query
name: q
required: true
type: string
- description: 'If not provided, results are sorted by best match.'
enum:
- stars
- forks
- updated
in: query
name: sort
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/search-repositories'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/search/users:
get:
description: Search users.
parameters:
- default: desc
description: The sort field. if sort param is provided. Can be either asc or desc.
enum:
- desc
- asc
in: query
name: order
type: string
- description: |
The search terms. This can be any combination of the supported user
search parameters:
'Search In' Qualifies which fields are searched. With this qualifier you
can restrict the search to just the username, public email, full name,
location, or any combination of these.
'Repository count' Filters users based on the number of repositories they
have.
'Location' Filter users by the location indicated in their profile.
'Language' Search for users that have repositories that match a certain
language.
'Created' Filter users based on when they joined.
'Followers' Filter users based on the number of followers they have.
in: query
name: q
required: true
type: string
- description: 'If not provided, results are sorted by best match.'
enum:
- followers
- repositories
- joined
in: query
name: sort
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/search-users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/teams/{teamId}':
delete:
description: |
Delete team.
In order to delete a team, the authenticated user must be an owner of the
org that the team is associated with.
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get team.
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/team'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: |
Edit team.
In order to edit a team, the authenticated user must be an owner of the org
that the team is associated with.
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/editTeam'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/team'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/teams/{teamId}/members':
get:
description: |
List team members.
In order to list members in a team, the authenticated user must be a member
of the team.
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/teams/{teamId}/members/{username}':
delete:
description: |
The "Remove team member" API is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Remove team membership API instead. It allows you to remove both active and pending memberships.
Remove team member.
In order to remove a user from a team, the authenticated user must have 'admin'
permissions to the team or be an owner of the org that the team is associated
with.
NOTE This does not delete the user, it just remove them from the team.
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: Name of a member.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Team member removed.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: |
The "Get team member" API is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Get team membership API instead. It allows you to get both active and pending memberships.
Get team member.
In order to get if a user is a member of a team, the authenticated user mus
be a member of the team.
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: Name of a member.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: User is a member.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: User is not a member.
put:
description: |
The API (described below) is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Add team membership API instead. It allows you to invite new organization members to your teams.
Add team member.
In order to add a user to a team, the authenticated user must have 'admin'
permissions to the team or be an owner of the org that the team is associated
with.
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: Name of a member.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Team member added.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'422':
description: 'If you attempt to add an organization to a team, you will get this.'
schema:
$ref: '#/definitions/organizationAsTeamMember'
'/teams/{teamId}/memberships/{username}':
delete:
description: |
Remove team membership.
In order to remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. NOTE: This does not delete the user, it just remo...
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: Name of a member.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Team member removed.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: |
Get team membership.
In order to get a user's membership with a team, the authenticated user must be a member of the team or an owner of the team's organization.
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: Name of a member.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: User is a member.
schema:
$ref: '#/definitions/teamMembership'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: User has no membership with team
put:
description: |
Add team membership.
In order to add a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with.
If the user is already a part of the team's organization (meaning they're on at least one other team in the organization), this endpoint will add the user to the team.
If the user is completely unaffiliated with the team's organization (meaning they're on none of the organization's teams), this endpoint will send an invitation to the user via email. This newly-created membership will be in the 'pending' sta...
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: Name of a member.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: Team member added.
schema:
$ref: '#/definitions/teamMembership'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'422':
description: 'If you attempt to add an organization to a team, you will get this.'
schema:
$ref: '#/definitions/organizationAsTeamMember'
'/teams/{teamId}/repos':
get:
description: List team repos
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/teamRepos'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/teams/{teamId}/repos/{org}/{repo}':
put:
description: 'In order to add a repository to a team, the authenticated user must be an owner of the org that the team is associated with. Also, the repository must be owned by the organization, or a direct fork of a repository owned by the org...
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: Name of a organization.
in: path
name: org
required: true
type: string
- description: Name of a repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/teams/{teamId}/repos/{owner}/{repo}':
delete:
description: 'In order to remove a repository from a team, the authenticated user must be an owner of the org that the team is associated with. NOTE: This does not delete the repository, it just removes it from the team.'
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: Name of a repository owner.
in: path
name: owner
required: true
type: string
- description: Name of a repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Check if a team manages a repository
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: Name of a repository owner.
in: path
name: owner
required: true
type: string
- description: Name of a repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user:
get:
description: Get the authenticated user.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/user'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Update the authenticated user.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/user-update'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/user'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/emails:
delete:
description: |
Delete email address(es).
You can include a single email address or an array of addresses.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/user-emails'
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: |
List email addresses for a user.
In the final version of the API, this method will return an array of hashes
with extended information for each email address indicating if the address
has been verified and if it's primary email address for GitHub.
Until API v3 is finalized, use the application/vnd.github.v3 media type to
get other response format.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
produces:
- application/vnd.github.v3
responses:
'200':
description: OK
schema:
$ref: '#/definitions/user-emails'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Add email address(es).
You can post a single email address or an array of addresses.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/emailsPost'
responses:
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/followers:
get:
description: List the authenticated user's followers
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/following:
get:
description: List who the authenticated user is following.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/user/following/{username}':
delete:
description: |
Unfollow a user.
Unfollowing a user requires the user to be logged in and authenticated with
basic auth or OAuth with the user:follow scope.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: User unfollowed.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Check if you are following a user.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Response if you are following this user.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: Response if you are not following this user.
put:
description: |
Follow a user.
Following a user requires the user to be logged in and authenticated with
basic auth or OAuth with the user:follow scope.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: You are now following the user.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/issues:
get:
description: |
List issues.
List all issues across owned and member repositories for the authenticated
user.
parameters:
- default: all
description: |
Issues assigned to you / created by you / mentioning you / you're
subscribed to updates for / All issues the authenticated user can see
enum:
- assigned
- created
- mentioned
- subscribed
- all
in: query
name: filter
required: true
type: string
- default: open
enum:
- open
- closed
in: query
name: state
required: true
type: string
- description: 'String list of comma separated Label names. Example - bug,ui,@high.'
in: query
name: labels
required: true
type: string
- default: created
enum:
- created
- updated
- comments
in: query
name: sort
required: true
type: string
- default: desc
enum:
- asc
- desc
in: query
name: direction
required: true
type: string
- description: |
Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only issues updated at or after this time are returned.
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/issues'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/keys:
get:
description: |
List your public keys.
Lists the current user's keys. Management of public keys via the API requires
that you are authenticated through basic auth, or OAuth with the 'user', 'write:public_key' scopes.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gitignore'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a public key.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/user-keys-post'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/user-keys-keyId'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/user/keys/{keyId}':
delete:
description: 'Delete a public key. Removes a public key. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:public_key scope.'
parameters:
- description: ID of key.
in: path
name: keyId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get a single public key.
parameters:
- description: ID of key.
in: path
name: keyId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/user-keys-keyId'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/orgs:
get:
description: List public and private organizations for the authenticated user.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gitignore'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/repos:
get:
description: |
List repositories for the authenticated user. Note that this does not include
repositories owned by organizations which the user can access. You can lis
user organizations and list organization repositories separately.
parameters:
- default: all
enum:
- all
- public
- private
- forks
- sources
- member
in: query
name: type
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repos'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a new repository for the authenticated user. OAuth users must supply
repo scope.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/postRepo'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/repos'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/starred:
get:
description: List repositories being starred by the authenticated user.
parameters:
- description: Ignored without 'sort' parameter.
in: query
name: direction
type: string
- default: created
description: ''
enum:
- created
- updated
in: query
name: sort
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gitignore'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/user/starred/{owner}/{repo}':
delete:
description: Unstar a repository
parameters:
- description: Name of a repository owner.
in: path
name: owner
required: true
type: string
- description: Name of a repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Unstarred.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Check if you are starring a repository.
parameters:
- description: Name of a repository owner.
in: path
name: owner
required: true
type: string
- description: Name of a repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: This repository is starred by you.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: This repository is not starred by you.
put:
description: Star a repository.
parameters:
- description: Name of a repository owner.
in: path
name: owner
required: true
type: string
- description: Name of a repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Repository starred.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/subscriptions:
get:
description: List repositories being watched by the authenticated user.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/user-userId-subscribitions'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/user/subscriptions/{owner}/{repo}':
delete:
description: Stop watching a repository
parameters:
- description: Name of the owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Unwatched.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Check if you are watching a repository.
parameters:
- description: Name of the owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Repository is watched by you.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: Repository is not watched by you.
put:
description: Watch a repository.
parameters:
- description: Name of the owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Repository is watched.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/teams:
get:
description: List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user or repo scope when authenticating via OAuth.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/teams-list'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/users:
get:
description: |
Get all users.
This provides a dump of every user, in the order that they signed up for GitHub.
Note: Pagination is powered exclusively by the since parameter. Use the Link
header to get the URL for the next page of users.
parameters:
- description: The integer ID of the last User that you've seen.
in: query
name: since
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/users/{username}':
get:
description: Get a single user.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/users/{username}/events':
get:
description: 'If you are authenticated as the given user, you will see your private events. Otherwise, you''ll only see public events.'
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/users/{username}/events/orgs/{org}':
get:
description: This is the user's organization dashboard. You must be authenticated as the user to view this.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- in: path
name: org
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/users/{username}/followers':
get:
description: List a user's followers
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/users/{username}/following/{targetUser}':
get:
description: Check if one user follows another.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: Name of user.
in: path
name: targetUser
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Response if user follows target user.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: Response if user does not follow target user.
'/users/{username}/gists':
get:
description: List a users gists.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gists'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/users/{username}/keys':
get:
description: |
List public keys for a user.
Lists the verified public keys for a user. This is accessible by anyone.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gitignore'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/users/{username}/orgs':
get:
description: List all public organizations for a user.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gitignore'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/users/{username}/received_events':
get:
description: These are events that you'll only see public events.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/users/{username}/received_events/public':
get:
description: List public events that a user has received
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/users/{username}/repos':
get:
description: List public repositories for the specified user.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- default: all
enum:
- all
- public
- private
- forks
- sources
- member
in: query
name: type
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repos'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/users/{username}/starred':
get:
description: List repositories being starred by a user.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/users/{username}/subscriptions':
get:
description: List repositories being watched by a user.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
definitions:
asset:
properties:
content_type:
type: string
created_at:
type: string
download_count:
type: number
id:
type: number
label:
type: string
name:
type: string
size:
type: number
state:
type: string
updated_at:
type: string
uploader:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: number
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
url:
type: string
type: object
assetPatch:
properties:
label:
type: string
name:
type: string
required:
- name
type: object
assets:
items:
properties:
content_type:
type: string
created_at:
type: string
download_count:
type: number
id:
type: number
label:
type: string
name:
type: string
size:
type: number
state:
type: string
updated_at:
type: string
uploader:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: number
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
url:
type: string
type: object
examples/githubcl-openapi.yaml view on Meta::CPAN
type: string
url:
type: string
type: object
type: object
type: array
gitCommit:
properties:
author:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
parents:
type: string
tree:
type: string
type: object
gitRefPatch:
properties:
force:
type: boolean
sha:
type: string
type: object
gitignore:
items: {}
type: array
gitignore-lang:
properties:
name:
type: string
source:
type: string
type: object
headBranch:
properties:
object:
properties:
sha:
type: string
type:
type: string
url:
type: string
type: object
ref:
type: string
url:
type: string
type: object
headBranchBody:
properties:
force:
description: '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.'
type: boolean
sha:
description: String of the SHA1 value to set this reference to.
type: string
required:
- sha
- force
type: object
heads:
items:
properties:
commit:
properties:
sha:
type: string
url:
type: string
type: object
name:
type: string
tarball_url:
type: string
zipball_url:
type: string
type: object
type: array
hook:
items:
properties:
active:
type: boolean
config:
properties:
content_type:
type: string
url:
type: string
type: object
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
events:
items:
enum:
- push
- issues
- issue_comment
- commit_comment
- pull_request
- pull_request_review_comment
- gollum
- watch
- download
- fork
- fork_apply
- member
- public
- team_add
- status
type: array
id:
type: integer
name:
examples/githubcl-openapi.yaml view on Meta::CPAN
position:
type: integer
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
user:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: object
type: array
pullsPost:
properties:
base:
type: string
body:
type: string
head:
type: string
title:
type: string
type: object
punchCardStats:
items:
type: integer
type: array
putSubscription:
properties:
created_at:
type: string
ignored:
type: boolean
reason:
type: object
subscribed:
type: boolean
thread_url:
type: string
url:
type: string
type: object
rate_limit:
properties:
rate:
properties:
limit:
type: integer
remaining:
type: integer
reset:
type: integer
type: object
readme:
properties:
_links:
properties:
git:
type: string
html:
type: string
self:
type: string
type: object
content:
type: string
encoding:
type: string
git_url:
type: string
html_url:
type: string
name:
type: string
path:
type: string
sha:
type: string
size:
type: integer
type:
type: string
url:
type: string
type: object
ref:
items:
properties:
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
creator:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
description:
type: string
id:
type: integer
state:
type: string
target_url:
examples/githubcl-openapi.yaml view on Meta::CPAN
commit_url:
type: string
name:
type: string
repository_url:
type: string
sha:
type: string
state:
type: string
statuses:
items:
properties:
context:
type: string
created_at:
type: string
description:
type: string
id:
type: number
state:
type: string
target_url:
type: string
updated_at:
type: string
url:
type: string
type: object
type: array
type: object
type: array
refs:
items:
properties:
object:
properties:
sha:
type: string
type:
type: string
url:
type: string
type: object
ref:
type: string
url:
type: string
type: object
type: array
refsBody:
properties:
ref:
type: string
sha:
type: string
type: object
release:
properties:
assets:
items:
properties:
content_type:
type: string
created_at:
type: string
download_count:
type: integer
id:
type: integer
label:
type: string
name:
type: string
size:
type: integer
state:
type: string
updated_at:
type: string
uploader:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
url:
type: string
type: object
type: array
assets_url:
type: string
author:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
body:
type: string
created_at:
type: string
draft:
type: boolean
html_url:
type: string
id:
type: integer
name:
type: string
prerelease:
type: boolean
published_at:
type: string
tag_name:
type: string
tarball_url:
type: string
target_commitish:
type: string
upload_url:
type: string
url:
type: string
zipball_url:
type: string
type: object
release-create:
properties:
body:
type: string
draft:
type: boolean
name:
type: string
prerelease:
type: boolean
tag_name:
type: string
target_commitish:
type: string
type: object
releases:
items:
properties:
assets:
items:
properties:
content_type:
type: string
created_at:
type: string
download_count:
type: integer
id:
type: integer
label:
type: string
name:
type: string
size:
type: integer
state:
type: string
updated_at:
type: string
uploader:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
url:
type: string
type: object
type: array
assets_url:
type: string
author:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
body:
type: string
created_at:
type: string
draft:
type: boolean
html_url:
type: string
id:
type: integer
name:
type: string
prerelease:
type: boolean
published_at:
type: string
tag_name:
type: string
tarball_url:
type: string
target_commitish:
type: string
( run in 1.270 second using v1.01-cache-2.11-cpan-39bf76dae61 )