API-CLI
view release on metacpan or search on metacpan
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) 19xx name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the
appropriate parts of the General Public License. Of course, the
commands you use may be called something other than `show w' and `show
c'; they could even be mouse-clicks or menu items--whatever suits your
program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here a sample; alter the names:
copy = t/00.compile.t
[GatherDir]
exclude_filename = Makefile.PL
exclude_filename = t/00.compile.t
[MetaResources]
bugtracker.web = https://github.com/perlpunk/API-CLI-p5/issues
repository.url = git://github.com/perlpunk/API-CLI-p5.git
repository.web = https://github.com/perlpunk/API-CLI-p5
repository.type = git
examples/bash/githubcl.bash view on Meta::CPAN
case ${MYWORDS[$INDEX-1]} in
--data-file)
;;
esac
;;
esac
;;
/orgs/:org/repos)
FLAGS+=()
OPTIONS+=('--q-type' '')
__githubcl_handle_options_flags
case $INDEX in
2)
__comp_current_options || return
;;
*)
__comp_current_options true || return # after parameters
case ${MYWORDS[$INDEX-1]} in
--data-file)
;;
--q-type)
_githubcl_compreply "'all'"$'\n'"'public'"$'\n'"'private'"$'\n'"'forks'"$'\n'"'sources'"$'\n'"'member'"
;;
esac
;;
esac
;;
/orgs/:org/teams)
FLAGS+=()
OPTIONS+=()
examples/bash/githubcl.bash view on Meta::CPAN
esac
;;
/user/orgs)
FLAGS+=()
OPTIONS+=()
__githubcl_handle_options_flags
__comp_current_options true || return # no subcmds, no params/opts
;;
/user/repos)
FLAGS+=()
OPTIONS+=('--q-type' '')
__githubcl_handle_options_flags
case $INDEX in
*)
__comp_current_options true || return # after parameters
case ${MYWORDS[$INDEX-1]} in
--data-file)
;;
--q-type)
_githubcl_compreply "'all'"$'\n'"'public'"$'\n'"'private'"$'\n'"'forks'"$'\n'"'sources'"$'\n'"'member'"
;;
esac
;;
esac
;;
/user/starred)
FLAGS+=()
OPTIONS+=('--q-direction' 'Ignored without '"'"'sort'"'"' parameter.' '--q-sort' '')
examples/bash/githubcl.bash view on Meta::CPAN
case ${MYWORDS[$INDEX-1]} in
--data-file)
;;
esac
;;
esac
;;
/users/:username/repos)
FLAGS+=()
OPTIONS+=('--q-type' '')
__githubcl_handle_options_flags
case $INDEX in
2)
__comp_current_options || return
;;
*)
__comp_current_options true || return # after parameters
case ${MYWORDS[$INDEX-1]} in
--data-file)
;;
--q-type)
_githubcl_compreply "'all'"$'\n'"'public'"$'\n'"'private'"$'\n'"'forks'"$'\n'"'sources'"$'\n'"'member'"
;;
esac
;;
esac
;;
/users/:username/starred)
FLAGS+=()
OPTIONS+=()
examples/bash/metacpancl.bash view on Meta::CPAN
case ${MYWORDS[$INDEX-1]} in
--data-file)
;;
esac
;;
esac
;;
/pod/:module)
FLAGS+=()
OPTIONS+=('--q-content-type' 'Default is text/html')
__metacpancl_handle_options_flags
case $INDEX in
2)
__comp_current_options || return
;;
*)
__comp_current_options true || return # after parameters
case ${MYWORDS[$INDEX-1]} in
--data-file)
;;
--q-content-type)
_metacpancl_compreply "'text/html'"$'\n'"'text/plain'"$'\n'"'text/x-pod'"$'\n'"'text/x-markdown'"
;;
esac
;;
esac
;;
/release/:author/:release)
FLAGS+=()
OPTIONS+=()
examples/digitaloceancl-appspec.yaml view on Meta::CPAN
/droplets:
get:
description: List all droplets
/droplets/:id:
get:
description: Retrieve a droplet by id
parameters:
- in: path
name: id
required: true
type: integer
/droplets/:id/actions:
post:
description: Trigger droplet action
parameters:
- description: action type
in: body
name: type
required: true
type:
enum:
- rename
- description: new droplet name
in: body
name: name
required: true
type: string
schemes:
- https
swagger: 2.0
options:
- name: data-file
summary: File with data for POST/PUT/PATCH/DELETE requests
type: file
- aliases:
- d
name: debug
summary: debug
type: flag
- aliases:
- v
name: verbose
summary: verbose
type: flag
subcommands:
GET:
op: apicall
subcommands:
/account:
options: []
parameters: []
summary: Account information
/droplets:
options: []
parameters: []
summary: List all droplets
/droplets/:id:
options: []
parameters:
- name: id
required: 1
summary: ~
type: integer
summary: Retrieve a droplet by id
summary: GET call
POST:
op: apicall
subcommands:
/droplets/:id/actions:
options: []
parameters: []
summary: Trigger droplet action
summary: POST call
examples/digitaloceancl-openapi.yaml view on Meta::CPAN
description: Account information
parameters: []
/droplets:
get:
description: List all droplets
/droplets/:id:
get:
description: Retrieve a droplet by id
parameters:
- name: id
type: integer
required: true
in: path
/droplets/:id/actions:
post:
description: Trigger droplet action
parameters:
- name: type
in: body
description: action type
required: true
type:
enum:
- rename
- name: name
in: body
description: new droplet name
required: true
type: string
# vim:et:sts=2:sws=2:sw=2:foldmethod=indent
examples/githubcl-appspec.yaml view on Meta::CPAN
version: '0.001'
class: API::CLI
name: githubcl
openapi:
basePath: /
consumes:
- application/json
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
type: array
assignees:
items:
properties:
avatar_url:
type: integer
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
blob:
properties:
content:
type: string
encoding:
enum:
- utf-8
- base64
sha:
type: string
size:
type: integer
type: object
blobs:
properties:
sha:
type: string
type: object
branch:
properties:
_links:
properties:
html:
type: string
self:
type: string
type: object
commit:
properties:
author:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
commit:
properties:
author:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
committer:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
committer:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
url:
type: string
type: object
name:
type: string
type: object
branches:
items:
properties:
commit:
properties:
sha:
type: string
url:
type: string
type: object
name:
type: string
type: object
type: array
codeFrequencyStats:
items:
type: integer
type: array
collaborators:
items:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
comment:
properties:
body:
type: string
type: object
commentBody:
properties:
body:
type: string
required:
- body
type: object
comments:
items:
properties:
body:
type: string
created_at:
description: ISO 8601.
type: string
id:
type: integer
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
commit:
properties:
author:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
commit:
properties:
author:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
committer:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
committer:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
files:
items:
properties:
additions:
type: integer
blob_url:
type: string
changes:
type: integer
deletions:
type: integer
filename:
type: string
patch:
type: string
raw_url:
type: string
status:
type: string
type: object
type: array
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
stats:
properties:
additions:
type: integer
deletions:
type: integer
total:
type: integer
type: object
url:
type: string
type: object
commitActivityStats:
items:
properties:
days:
items:
type: integer
type: array
total:
type: integer
week:
type: integer
type: object
type: array
commitBody:
properties:
body:
type: string
line:
description: Deprecated - Use position parameter instead.
type: string
number:
description: Line number in the file to comment on. Defaults to null.
type: string
path:
description: Relative path of the file to comment on.
type: string
position:
description: Line index in the diff to comment on.
type: integer
sha:
description: SHA of the commit to comment on.
type: string
required:
- sha
- body
type: object
commitComments:
properties:
body:
type: string
commit_id:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
html_url:
type: string
id:
type: integer
line:
type: integer
path:
type: string
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
commits:
items:
properties:
author:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
commit:
properties:
author:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
committer:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
committer:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
url:
type: string
type: object
type: array
compare-commits:
properties:
ahead_by:
type: integer
base_commit:
properties:
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
commit:
properties:
author:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
committer:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
committer:
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
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
url:
type: string
type: object
behind_by:
type: integer
commits:
items:
properties:
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
commit:
properties:
author:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
committer:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
committer:
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
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
url:
type: string
type: object
type: array
diff_url:
type: string
files:
items:
properties:
additions:
type: integer
blob_url:
type: string
changes:
type: integer
contents_url:
type: string
deletions:
type: integer
filename:
type: string
patch:
type: string
raw_url:
type: string
sha:
type: string
status:
type: string
type: object
type: array
html_url:
type: string
patch_url:
type: string
permalink_url:
type: string
status:
type: string
total_commits:
type: integer
url:
type: string
type: object
contents-path:
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
contributors:
items:
properties:
avatar_url:
type: string
contributions:
type: integer
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
contributorsStats:
items:
properties:
author:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
total:
description: The Total number of commits authored by the contributor.
type: integer
weeks:
items:
properties:
a:
description: Number of additions.
type: integer
c:
description: Number of commits.
type: integer
d:
description: Number of deletions.
type: integer
w:
description: Start of the week.
type: string
type: object
type: array
type: object
type: array
createDownload:
properties:
accesskeyid:
type: string
acl:
type: string
bucket:
type: string
content_type:
type: string
description:
type: string
download_count:
type: integer
expirationdate:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
html_url:
type: string
id:
type: integer
mime_type:
type: string
name:
type: string
path:
type: string
policy:
type: string
prefix:
type: string
redirect:
type: boolean
s3_url:
type: string
signature:
type: string
size:
type: integer
url:
type: string
type: object
createFile:
properties:
commit:
properties:
author:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
committer:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
html_url:
type: string
message:
type: string
parents:
items:
properties:
html_url:
type: string
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
content:
properties:
_links:
properties:
git:
type: string
html:
type: string
self:
type: string
type: object
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
type: object
createFileBody:
properties:
committer:
properties:
email:
type: string
name:
type: string
type: object
content:
type: string
message:
type: string
type: object
deleteFile:
properties:
commit:
properties:
author:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
committer:
properties:
date:
type: string
email:
type: string
name:
type: string
html_url:
type: string
message:
type: string
parents:
properties:
html_url:
type: string
sha:
type: string
url:
type: string
type: object
sha:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
content:
type: string
type: object
deleteFileBody:
properties:
committer:
properties:
email:
type: string
name:
type: string
type: object
message:
type: string
sha:
type: string
type: object
deployment:
properties:
description:
type: string
payload:
properties:
deploy_user:
type: string
environment:
type: string
room_id:
type: number
type: object
ref:
type: string
type: object
deployment-resp:
properties:
created_at:
type: string
creator:
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
description:
type: string
id:
type: integer
payload:
type: string
sha:
type: string
statuses_url:
type: string
updated_at:
type: string
url:
type: string
type: object
deployment-statuses:
items:
properties:
created_at:
type: string
creator:
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
description:
type: string
id:
type: integer
payload:
type: string
state:
type: string
target_url:
type: string
updated_at:
type: string
url:
type: string
type: object
type: array
deployment-statuses-create:
properties:
description:
type: string
state:
type: string
target_url:
type: string
type: object
downloadBody:
properties:
content_type:
type: string
description:
type: string
name:
type: string
size:
description: Size of file in bytes.
type: integer
required:
- name
- size
type: object
downloads:
properties:
content_type:
type: string
description:
type: string
download_count:
type: integer
html_url:
type: string
id:
type: integer
name:
type: string
size:
type: integer
url:
type: string
type: object
editTeam:
properties:
name:
type: string
permission:
enum:
- pull
- push
- admin
required:
- name
type: object
emailsPost:
items:
type: string
type: array
emojis:
properties:
'+1':
type: string
'-1':
type: string
'100':
type: string
'1234':
type: string
8ball:
type: string
a:
type: string
ab:
type: string
type: object
event:
properties:
actor:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
commit_id:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
event:
type: string
issue:
properties:
assignee:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
body:
type: string
closed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
comments:
type: integer
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
html_url:
type: string
labels:
items:
properties:
color:
type: string
name:
type: string
url:
type: string
type: object
type: array
milestone:
properties:
closed_issues:
type: integer
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
due_on:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
number:
type: integer
open_issues:
type: integer
state:
enum:
- open
- closed
title:
type: string
url:
type: string
type: object
number:
type: integer
pull_request:
properties:
diff_url:
type: string
html_url:
type: string
patch_url:
type: string
type: object
state:
enum:
- open
- closed
title:
type: string
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
url:
type: string
type: object
events:
properties:
actor:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
created_at:
type: object
id:
type: integer
org:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
payload:
properties: {}
type: object
public:
type: boolean
repo:
properties:
id:
type: integer
name:
type: string
url:
type: string
type: object
type:
type: string
type: object
feeds:
properties:
_links:
properties:
current_user:
properties:
href:
type: string
type:
type: string
type: object
current_user_actor:
properties:
href:
type: string
type:
type: string
type: object
current_user_organization:
properties:
href:
type: string
type:
type: string
type: object
current_user_public:
properties:
href:
type: string
type:
type: string
type: object
timeline:
properties:
href:
type: string
type:
type: string
type: object
user:
properties:
href:
type: string
type:
type: string
type: object
current_user_actor_url:
type: string
current_user_organization_url:
type: string
current_user_public:
type: string
current_user_url:
type: string
timeline_url:
type: string
user_url:
type: string
type: object
fork:
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
forkBody:
properties:
organization:
type: string
type: object
forks:
items:
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
type: array
gist:
properties:
comments:
type: integer
comments_url:
type: string
created_at:
description: 'Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.'
type: string
description:
type: string
files:
properties:
ring.erl:
properties:
filename:
type: string
raw_url:
type: string
size:
type: integer
type: object
type: object
forks:
items:
properties:
created_at:
description: 'Timestamp in 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
git_pull_url:
type: string
git_push_url:
type: string
history:
items:
properties:
change_status:
properties:
additions:
type: integer
deletions:
type: integer
total:
type: integer
type: object
committed_at:
description: 'Timestamp in 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
version:
type: string
type: object
type: array
html_url:
type: string
id:
type: string
public:
type: boolean
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
gists:
items:
properties:
comments:
type: integer
comments_url:
type: string
created_at:
type: string
description:
type: string
files:
properties:
ring.erl:
properties:
filename:
type: string
raw_url:
type: string
size:
type: integer
type: object
type: object
git_pull_url:
type: string
git_push_url:
type: string
html_url:
type: string
id:
type: string
public:
type: boolean
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
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:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
type: object
type: array
hookBody:
properties:
active:
type: boolean
add_events:
items:
type: string
type: array
type: object
issue:
properties:
assignee:
type: string
body:
type: string
labels:
items:
type: string
type: array
milestone:
type: number
title:
type: string
type: object
issueBody:
properties:
assignee:
type: string
body:
type: string
labels:
items:
type: string
type: array
milestone:
type: number
title:
type: string
type: object
issues:
items:
properties:
assignee:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
body:
type: string
closed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
comments:
type: integer
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
html_url:
type: string
labels:
items:
properties:
color:
type: string
name:
type: string
url:
type: string
type: object
type: array
milestone:
properties:
closed_issues:
type: integer
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
due_on:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
number:
type: integer
open_issues:
type: integer
state:
enum:
- open
- closed
title:
type: string
url:
type: string
type: object
number:
type: integer
pull_request:
properties:
diff_url:
type: string
html_url:
type: string
patch_url:
type: string
type: object
state:
enum:
- open
- closed
title:
type: string
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
issuesComment:
properties:
body:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
html_url:
type: string
id:
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
issuesComments:
items:
properties:
_links:
properties:
html:
properties:
href:
type: string
type: object
pull_request:
properties:
href:
type: string
type: object
self:
properties:
href:
type: string
type: object
type: object
body:
type: string
commit_id:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
id:
type: integer
path:
type: string
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
key:
properties:
id:
type: integer
key:
type: string
title:
type: string
url:
type: string
type: object
keyBody:
properties:
key:
type: string
title:
type: string
type: object
keys:
items:
properties:
id:
type: integer
key:
type: string
title:
type: string
url:
type: string
type: object
type: array
label:
properties:
color:
maxLength: 6
minLength: 6
type: string
name:
type: string
url:
type: string
type: object
labels:
items:
properties:
color:
maxLength: 6
minLength: 6
type: string
name:
type: string
url:
type: string
type: object
type: array
labelsBody:
items:
type: string
type: array
languages:
additionalProperties:
type: integer
type: object
markdown:
properties:
context:
type: string
mode:
type: string
text:
type: string
type: object
members:
items:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
merge:
properties:
merged:
type: boolean
message:
type: string
sha:
type: string
type: object
mergePullBody:
properties:
commit_message:
type: string
type: object
mergesBody:
properties:
base:
type: string
commit_message:
type: string
head:
type: string
type: object
mergesConflict:
properties:
message:
description: Error message
type: string
type: object
mergesSuccessful:
properties:
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
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
comments_url:
type: string
commit:
properties:
author:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
comment_count:
type: integer
committer:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
committer:
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
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
merged:
type: boolean
message:
type: string
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
url:
type: string
type: object
meta:
properties:
git:
items:
description: An Array of IP addresses in CIDR format specifying the Git
servers at GitHub.
type: string
type: array
hooks:
items:
description: An Array of IP addresses in CIDR format specifying the addresses
that incoming service hooks will originate from.
type: string
type: array
type: object
milestone:
properties:
closed_issues:
type: integer
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
due_on:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
number:
type: integer
open_issues:
type: integer
state:
enum:
- open
- closed
title:
type: string
url:
type: string
type: object
milestoneBody:
properties:
description:
type: string
due_on:
type: string
state:
type: string
title:
type: string
type: object
milestoneUpdate:
properties:
description:
type: string
due_on:
type: string
state:
type: string
title:
type: string
type: object
notificationMarkRead:
properties:
last_read_at:
type: string
type: object
notifications:
properties:
id:
type: integer
last_read_at:
type: string
reason:
type: string
repository:
properties:
description:
type: string
fork:
type: boolean
full_name:
type: string
html_url:
type: string
id:
type: integer
name:
type: string
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
url:
type: string
type: object
subject:
properties:
latest_comment_url:
type: string
title:
type: string
type:
type: string
url:
type: string
type: object
unread:
type: boolean
updated_at:
type: string
url:
type: string
type: object
orgMembers:
items:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
orgPublicMembers:
items:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
orgTeams:
items:
properties:
id:
type: integer
name:
type: string
url:
type: string
type: object
type: array
orgTeamsPost:
properties:
name:
type: string
permission:
enum:
- pull
- push
- admin
repo_names:
items:
type: string
type: array
required:
- name
type: object
organization:
properties:
avatar_url:
type: string
blog:
type: string
company:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
followers:
type: integer
following:
type: integer
html_url:
type: string
id:
type: integer
location:
type: string
login:
type: string
name:
type: string
public_gists:
type: integer
public_repos:
type: integer
type:
type: string
url:
type: string
type: object
organizationAsTeamMember:
properties:
errors:
items:
properties:
code:
type: string
field:
type: string
resource:
type: string
type: object
type: array
message:
type: string
type: object
participationStats:
properties:
all:
items:
type: integer
type: array
owner:
items:
type: integer
type: array
type: object
patchGist:
properties:
description:
type: string
files:
properties:
delete_this_file.txt:
type: string
file1.txt:
properties:
content:
type: string
type: object
new_file.txt:
properties:
content:
type: string
type: object
old_name.txt:
properties:
content:
type: string
filename:
type: string
type: object
type: object
patchOrg:
properties:
billing_email:
description: Billing email address. This address is not publicized.
type: string
company:
type: string
email:
description: Publicly visible email address.
type: string
location:
type: string
name:
type: string
type: object
postComment:
properties:
body:
type: string
required:
- body
type: object
postGist:
properties:
description:
type: string
files:
properties:
file1.txt:
properties:
content:
type: string
type: object
type: object
public:
type: boolean
type: object
postRepo:
properties:
auto_init:
description: True to create an initial commit with empty README. Default
is false.
type: boolean
description:
type: string
gitignore_template:
description: 'Desired language or platform .gitignore template to apply.
Use the name of the template without the extension. For example, "Haskell"
Ignored if auto_init parameter is not provided. '
type: string
has_downloads:
description: True to enable downloads for this repository, false to disable
them. Default is true.
type: boolean
has_issues:
description: True to enable issues for this repository, false to disable
them. Default is true.
type: boolean
has_wiki:
description: True to enable the wiki for this repository, false to disable
it. Default is true.
type: boolean
homepage:
type: string
name:
type: string
private:
description: True to create a private repository, false to create a public
one. Creating private repositories requires a paid GitHub account.
type: boolean
team_id:
description: The id of the team that will be granted access to this repository.
This is only valid when creating a repo in an organization.
type: integer
required:
- name
type: object
pullRequest:
properties:
_links:
properties:
comments:
properties:
href:
type: string
type: object
html:
properties:
href:
type: string
type: object
review_comments:
properties:
href:
type: string
type: object
self:
properties:
href:
type: string
type: object
type: object
additions:
type: integer
base:
properties:
label:
type: string
ref:
type: string
repo:
properties:
clone_url:
type: string
created_at:
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: 'null'
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
sha:
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
body:
type: string
changed_files:
type: integer
closed_at:
type: string
comments:
type: integer
commits:
type: integer
created_at:
type: string
deletions:
type: integer
diff_url:
type: string
head:
properties:
label:
type: string
ref:
type: string
repo:
properties:
clone_url:
type: string
created_at:
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: 'null'
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
sha:
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
html_url:
type: string
issue_url:
type: string
merge_commit_sha:
type: string
mergeable:
type: boolean
merged:
type: boolean
merged_at:
type: string
merged_by:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
number:
type: integer
patch_url:
type: string
state:
type: string
title:
type: string
updated_at:
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
pullUpdate:
properties:
body:
type: string
state:
type: string
title:
type: string
type: object
pulls:
items:
properties:
_links:
properties:
comments:
properties:
href:
type: string
type: object
html:
properties:
href:
type: string
type: object
review_comments:
properties:
href:
type: string
type: object
self:
properties:
href:
type: string
type: object
type: object
base:
properties:
label:
type: string
ref:
type: string
repo:
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
sha:
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
body:
type: string
closed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
diff_url:
type: string
head:
properties:
label:
type: string
ref:
type: string
repo:
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
sha:
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
html_url:
type: string
issue_url:
type: string
merged_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
number:
type: integer
patch_url:
type: string
state:
enum:
- open
- closed
title:
type: string
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
pullsComment:
properties:
_links:
properties:
html:
properties:
href:
type: string
type: object
pull_request:
properties:
href:
type: string
type: object
self:
properties:
href:
type: string
type: object
type: object
body:
type: string
commit_id:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
id:
type: integer
path:
type: string
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
pullsCommentPost:
properties:
body:
type: string
commit_id:
type: string
path:
type: string
position:
type: number
type: object
pullsComments:
items:
properties:
_links:
properties:
html:
properties:
href:
type: string
type: object
pull_request:
properties:
href:
type: string
type: object
self:
properties:
href:
type: string
type: object
type: object
body:
type: string
commit_id:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
id:
type: integer
path:
type: string
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:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
type: object
type: array
refBody:
properties:
object:
properties:
sha:
type: string
type:
type: string
url:
type: string
type: object
ref:
type: string
url:
type: string
type: object
refStatus:
items:
properties:
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
upload_url:
type: string
url:
type: string
zipball_url:
type: string
type: object
type: array
repo:
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
has_downloads:
type: boolean
has_issues:
type: boolean
has_wiki:
type: boolean
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
organization:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
type:
type: string
url:
type: string
type: object
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
parent:
description: Is present when the repo is a fork. Parent is the repo this
repo was forked from.
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
source:
description: Is present when the repo is a fork. Source is the ultimate
source for the network.
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
repo-deployments:
items:
properties:
created_at:
type: string
creator:
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
description:
type: string
id:
type: integer
payload:
type: string
sha:
type: string
statuses_url:
type: string
updated_at:
type: string
url:
type: string
type: object
type: array
repoComments:
items:
properties:
body:
type: string
commit_id:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
html_url:
type: string
id:
type: integer
line:
type: integer
path:
type: string
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
repoCommit:
properties:
author:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
committer:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
repoCommitBody:
properties:
author:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
parents:
items:
type: string
type: array
tree:
type: string
required:
- message
- parents
- tree
type: object
repoEdit:
properties:
description:
type: string
has_downloads:
type: boolean
has_issues:
type: boolean
has_wiki:
type: boolean
homepage:
type: string
name:
type: string
private:
type: boolean
type: object
repos:
items:
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: array
repositories:
items:
properties:
description:
type: string
fork:
type: boolean
full_name:
type: string
html_url:
type: string
id:
type: integer
name:
type: string
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
url:
type: string
type: object
type: array
search-code:
properties:
items:
items:
properties:
git_url:
type: string
html_url:
type: string
name:
type: string
path:
type: string
repository:
properties:
archive_url:
type: string
assignees_url:
type: string
blobs_url:
type: string
branches_url:
type: string
collaborators_url:
type: string
comments_url:
type: string
commits_url:
type: string
compare_url:
type: string
contents_url:
type: string
contributors_url:
type: string
description:
type: string
downloads_url:
type: string
events_url:
type: string
fork:
type: boolean
forks_url:
type: string
full_name:
type: string
git_commits_url:
type: string
git_refs_url:
type: string
git_tags_url:
type: string
hooks_url:
type: string
html_url:
type: string
id:
type: integer
issue_comment_url:
type: string
issue_events_url:
type: string
issues_url:
type: string
keys_url:
type: string
labels_url:
type: string
languages_url:
type: string
merges_url:
type: string
milestones_url:
type: string
name:
type: string
notifications_url:
type: string
owner:
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
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
private:
type: boolean
pulls_url:
type: string
stargazers_url:
type: string
statuses_url:
type: string
subscribers_url:
type: string
subscription_url:
type: string
tags_url:
type: string
teams_url:
type: string
trees_url:
type: string
url:
type: string
type: object
score:
type: number
sha:
type: string
url:
type: string
type: object
type: array
total_count:
type: integer
type: object
search-issues:
properties:
items:
items:
properties:
assignee:
type: 'null'
body:
type: string
closed_at:
type: 'null'
comments:
type: integer
comments_url:
type: string
created_at:
type: string
events_url:
type: string
html_url:
type: string
id:
type: integer
labels:
items:
properties:
color:
type: string
name:
type: string
url:
type: string
type: object
type: array
labels_url:
type: string
milestone:
type: 'null'
number:
type: integer
pull_request:
properties:
diff_url:
type: 'null'
html_url:
type: 'null'
patch_url:
type: 'null'
type: object
score:
type: number
state:
type: string
title:
type: string
updated_at:
type: string
url:
type: string
user:
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
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
type: object
type: array
total_count:
type: integer
type: object
search-issues-by-keyword:
properties:
issues:
items:
properties:
body:
type: string
comments:
type: integer
created_at:
type: string
gravatar_id:
type: string
html_url:
type: string
labels:
items:
type: string
type: array
number:
type: integer
position:
type: integer
state:
type: string
title:
type: string
updated_at:
type: string
user:
type: string
votes:
type: integer
type: object
type: array
type: object
search-repositories:
properties:
items:
items:
properties:
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
default_branch:
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
received_events_url:
type: string
type:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
score:
type: number
size:
type: integer
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
type: array
total_count:
type: integer
type: object
search-repositories-by-keyword:
properties:
repositories:
items:
properties:
created:
type: string
created_at:
type: string
description:
type: string
followers:
type: integer
fork:
type: boolean
forks:
type: integer
has_downloads:
type: boolean
has_issues:
type: boolean
has_wiki:
type: boolean
homepage:
type: string
language:
type: string
name:
type: string
open_issues:
type: integer
owner:
type: string
private:
type: boolean
pushed:
type: string
pushed_at:
type: string
score:
type: number
size:
type: integer
type:
type: string
url:
type: string
username:
type: string
watchers:
type: integer
type: object
type: array
type: object
search-user-by-email:
properties:
user:
properties:
blog:
type: string
company:
type: string
created:
type: string
created_at:
type: string
email:
type: string
followers_count:
type: integer
following_count:
type: integer
gravatar_id:
type: string
id:
type: integer
location:
type: string
login:
type: string
name:
type: string
public_gist_count:
type: integer
public_repo_count:
type: integer
type:
type: string
type: object
type: object
search-users:
properties:
items:
items:
properties:
avatar_url:
type: string
followers_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
score:
type: number
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
type: array
total_count:
type: integer
type: object
search-users-by-keyword:
properties:
users:
items:
properties:
created:
type: string
created_at:
type: string
followers:
type: integer
followers_count:
type: integer
fullname:
type: string
gravatar_id:
type: string
id:
type: string
language:
type: string
location:
type: string
login:
type: string
name:
type: string
public_repo_count:
type: integer
repos:
type: integer
score:
type: number
type:
type: string
username:
type: string
type: object
type: array
type: object
stargazers:
items:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
subscribition:
properties:
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
ignored:
type: boolean
reason:
type: string
repository_url:
type: string
subscribed:
type: boolean
url:
type: string
type: object
subscribitionBody:
properties:
ignored:
type: boolean
subscribed:
type: boolean
type: object
subscription:
properties:
created_at:
type: string
ignored:
type: boolean
reason:
type: boolean
subscribed:
type: boolean
thread_url:
type: string
url:
type: string
type: object
tag:
properties:
message:
type: string
object:
properties:
sha:
type: string
type:
type: string
url:
type: string
type: object
sha:
type: string
tag:
type: string
tagger:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
url:
type: string
type: object
tags:
properties:
message:
description: String of the tag message.
type: string
object:
description: String of the SHA of the git object this is tagging.
type: string
tag:
type: string
tagger:
properties:
date:
description: Timestamp of when this object was tagged.
type: string
email:
description: String of the email of the author of the tag.
type: string
name:
description: String of the name of the author of the tag.
type: string
type: object
type:
description: String of the type of the object we’re tagging. Normally this
is a commit but it can also be a tree or a blob.
type: string
required:
- tag
- message
- object
- type
- tagger
type: object
team:
properties:
id:
type: integer
members_count:
type: integer
name:
type: string
permission:
type: string
repos_count:
type: integer
url:
type: string
type: object
teamMembership:
properties:
state:
type: string
url:
type: string
type: object
teamRepos:
items:
properties:
clone_url:
type: string
created_at:
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: 'null'
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
type: array
teams:
items:
properties:
id:
type: integer
name:
type: string
url:
type: string
type: object
type: array
teams-list:
items:
properties:
id:
type: integer
members_count:
type: integer
name:
type: string
organization:
properties:
avatar_url:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
permission:
type: string
repos_count:
type: integer
url:
type: string
type: object
type: array
tree:
properties:
sha:
type: string
tree:
items:
properties:
mode:
type: string
path:
type: string
sha:
type: string
size:
type: integer
type:
type: string
url:
type: string
type: object
type: array
url:
type: string
type: object
trees:
properties:
base_tree:
type: string
sha:
description: SHA1 checksum ID of the object in the tree.
type: string
tree:
items:
properties:
mode:
description: One of 100644 for file (blob), 100755 for executable
(blob), 040000 for subdirectory (tree), 160000 for submodule (commit)
or 120000 for a blob that specifies the path of a symlink.
enum:
- '100644'
- '100755'
- '040000'
- '160000'
- '120000'
type: string
path:
type: string
sha:
description: SHA1 checksum ID of the object in the tree.
type: string
type:
enum:
- blob
- tree
- commit
type: string
url:
type: string
type: object
type: array
url:
type: string
type: object
user:
properties:
avatar_url:
type: string
bio:
type: string
blog:
type: string
collaborators:
type: integer
company:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
disk_usage:
type: integer
email:
type: string
followers:
type: integer
following:
type: integer
gravatar_id:
type: string
hireable:
type: boolean
html_url:
type: string
id:
type: integer
location:
type: string
login:
type: string
name:
type: string
owned_private_repos:
type: integer
plan:
properties:
collaborators:
type: integer
name:
type: string
private_repos:
type: integer
space:
type: integer
type: object
private_gists:
type: integer
public_gists:
type: integer
public_repos:
type: integer
total_private_repos:
type: integer
type:
type: string
url:
type: string
type: object
user-emails:
items:
type: string
type: array
user-emails_final:
items: {}
type: array
user-keys:
items: {}
type: array
user-keys-keyId:
properties:
id:
type: integer
key:
type: string
title:
type: string
url:
type: string
type: object
user-keys-post:
properties:
key:
type: string
title:
type: string
type: object
user-update:
properties:
bio:
type: string
blog:
type: string
company:
type: string
email:
type: string
hireable:
type: boolean
location:
type: string
name:
type: string
type: object
user-userId:
properties:
avatar_url:
type: string
bio:
type: string
blog:
type: string
company:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
description: 'Note: The returned email is the user’s publicly visible email
address (or null if the user has not specified a public email address
in their profile).'
type: string
followers:
type: integer
following:
type: integer
gravatar_id:
type: string
hireable:
type: boolean
html_url:
type: string
id:
type: integer
location:
type: string
login:
type: string
name:
type: string
public_gists:
type: integer
public_repos:
type: integer
type:
type: string
url:
type: string
type: object
user-userId-starred:
items: {}
type: array
user-userId-subscribitions:
items:
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: integer
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: array
users:
items:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
users-userId-keys:
items: {}
type: array
users-userId-orgs:
items: {}
type: array
externalDocs:
url: https://developer.github.com/v3/
host: api.github.com
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:
examples/githubcl-appspec.yaml view on Meta::CPAN
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
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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.\n"
'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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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.\n"
'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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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:
examples/githubcl-appspec.yaml view on Meta::CPAN
subscribed to updates for / All issues the authenticated user can see
enum: &1
- assigned
- created
- mentioned
- subscribed
- all
in: query
name: filter
required: true
type: string
- default: open
enum: &2
- 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: &3
- created
- updated
- comments
in: query
name: sort
required: true
type: string
- default: desc
enum: &4
- 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: &5
- 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: &6
- 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: &7
- 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: &8
- 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: &9
- 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
examples/githubcl-appspec.yaml view on Meta::CPAN
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\n"
'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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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: &10
- assigned
- created
- mentioned
- subscribed
- all
in: query
name: filter
required: true
type: string
- default: open
enum: &11
- 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: &12
- created
- updated
- comments
in: query
name: sort
required: true
type: string
- default: desc
enum: &13
- 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:
examples/githubcl-appspec.yaml view on Meta::CPAN
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
examples/githubcl-appspec.yaml view on Meta::CPAN
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.\n"
'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
examples/githubcl-appspec.yaml view on Meta::CPAN
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: &14
- 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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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:
examples/githubcl-appspec.yaml view on Meta::CPAN
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.\n"
'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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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.\n"
'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: &15
- 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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
for details.
/repos/{owner}/{repo}/git/refs/{ref}:
delete:
description: "Delete a Reference\nExample: Deleting a branch: DELETE /repos/octocat/Hello-World/git/refs/heads/feature-a
\nExample: Deleting a tag: DELETE /repos/octocat/Hello-World/git/refs/tags/v1.0\n"
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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:
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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.\n"
'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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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: &16
- assigned
- created
- mentioned
- subscribed
- all
in: query
name: filter
required: true
type: string
- default: open
enum: &17
- 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: &18
- created
- updated
- comments
in: query
name: sort
required: true
type: string
- default: desc
enum: &19
- 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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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: &20
- 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.\n"
'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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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.\n"
'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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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.\n"
'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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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.\n"
'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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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: &21
- open
- closed
in: query
name: state
type: string
- description: Ignored without 'sort' parameter.
in: query
name: direction
type: string
- default: due_date
description: ''
enum: &22
- 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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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.\n"
'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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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: &23
- 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'
examples/githubcl-appspec.yaml view on Meta::CPAN
/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: &24
- 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.\n"
'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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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:
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
/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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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:
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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.\n"
'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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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}:
examples/githubcl-appspec.yaml view on Meta::CPAN
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: &25
- 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: |
examples/githubcl-appspec.yaml view on Meta::CPAN
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:
examples/githubcl-appspec.yaml view on Meta::CPAN
description: Search code.
parameters:
- default: desc
description: The sort field. if sort param is provided. Can be either asc
or desc.
enum: &26
- 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: &27
- 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:
examples/githubcl-appspec.yaml view on Meta::CPAN
100 results per page.)
parameters:
- default: desc
description: The sort field. if sort param is provided. Can be either asc
or desc.
enum: &28
- 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: &29
- 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:
examples/githubcl-appspec.yaml view on Meta::CPAN
description: Search repositories.
parameters:
- default: desc
description: The sort field. if sort param is provided. Can be either asc
or desc.
enum: &30
- 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: &31
- 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:
examples/githubcl-appspec.yaml view on Meta::CPAN
description: Search users.
parameters:
- default: desc
description: The sort field. if sort param is provided. Can be either asc
or desc.
enum: &32
- 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: &33
- 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.\n"
'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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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}:
examples/githubcl-appspec.yaml view on Meta::CPAN
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:
examples/githubcl-appspec.yaml view on Meta::CPAN
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.
examples/githubcl-appspec.yaml view on Meta::CPAN
/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 re...
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':
examples/githubcl-appspec.yaml view on Meta::CPAN
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' s...
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':
examples/githubcl-appspec.yaml view on Meta::CPAN
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 organization.
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.\n"
'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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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.\n"
'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: |
examples/githubcl-appspec.yaml view on Meta::CPAN
subscribed to updates for / All issues the authenticated user can see
enum: &34
- assigned
- created
- mentioned
- subscribed
- all
in: query
name: filter
required: true
type: string
- default: open
enum: &35
- 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: &36
- created
- updated
- comments
in: query
name: sort
required: true
type: string
- default: desc
enum: &37
- 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'
examples/githubcl-appspec.yaml view on Meta::CPAN
/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.\n"
'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:
examples/githubcl-appspec.yaml view on Meta::CPAN
parameters:
- default: all
enum: &38
- 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'
examples/githubcl-appspec.yaml view on Meta::CPAN
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: &39
- 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: &40
- 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.
produces:
- application/json
schemes:
- https
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: ''
examples/githubcl-appspec.yaml view on Meta::CPAN
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
swagger: '2.0'
x-hasEquivalentPaths: true
options:
- name: data-file
summary: File with data for POST/PUT/PATCH/DELETE requests
type: file
- aliases:
- d
name: debug
summary: debug
type: flag
- aliases:
- v
name: verbose
summary: verbose
type: flag
subcommands:
DELETE:
op: apicall
subcommands:
/gists/:id:
options: []
parameters:
- name: id
required: 1
summary: Id of gist.
type: integer
summary: Delete a gist.
/gists/:id/comments/:commentId:
options: []
parameters:
- name: id
required: 1
summary: Id of gist.
type: integer
- name: commentId
required: 1
summary: Id of comment.
type: integer
summary: Delete a comment.
/gists/:id/star:
options: []
parameters:
- name: id
required: 1
summary: Id of gist.
type: integer
summary: Unstar a gist.
/notifications/threads/:id/subscription:
options: []
parameters:
- name: id
required: 1
summary: Id of thread.
type: integer
summary: Delete a Thread Subscription.
/orgs/:org/members/:username:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
- name: username
required: 1
summary: Name of the user.
type: string
summary: Remove a member.
/orgs/:org/public_members/:username:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
- name: username
required: 1
summary: Name of the user.
type: string
summary: Conceal a user's membership.
/repos/:owner/:repo:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Delete a Repository.
/repos/:owner/:repo/collaborators/:user:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: user
required: 1
summary: Login of the user.
type: string
summary: Remove collaborator.
/repos/:owner/:repo/comments/:commentId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: commentId
required: 1
summary: Id of comment.
type: integer
summary: Delete a commit comment
/repos/:owner/:repo/contents/:path:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: path
required: 1
summary: ~
type: string
summary: Delete a file.
/repos/:owner/:repo/downloads/:downloadId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: downloadId
required: 1
summary: Id of download.
type: integer
summary: Deprecated. Delete a download.
/repos/:owner/:repo/git/refs/:ref:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: ref
required: 1
summary: ~
type: string
summary: Delete a Reference
/repos/:owner/:repo/hooks/:hookId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: hookId
required: 1
summary: Id of hook.
type: integer
summary: Delete a hook.
/repos/:owner/:repo/issues/:number/labels:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Number of issue.
type: integer
summary: Remove all labels from an issue....
/repos/:owner/:repo/issues/:number/labels/:name:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Number of issue.
type: integer
- name: name
required: 1
summary: Name of the label.
type: string
summary: Remove a label from an issue.
/repos/:owner/:repo/issues/comments/:commentId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: commentId
required: 1
summary: ID of comment.
type: integer
summary: Delete a comment.
/repos/:owner/:repo/keys/:keyId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: keyId
required: 1
summary: Id of key.
type: integer
summary: Delete a key.
/repos/:owner/:repo/labels/:name:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: name
required: 1
summary: Name of the label.
type: string
summary: Delete a label.
/repos/:owner/:repo/milestones/:number:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Number of milestone.
type: integer
summary: Delete a milestone.
/repos/:owner/:repo/pulls/comments/:commentId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: commentId
required: 1
summary: Id of comment.
type: integer
summary: Delete a comment.
/repos/:owner/:repo/releases/:id:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: id
required: 1
summary: ~
type: string
summary: Users with push access to the repository can delet...
/repos/:owner/:repo/releases/assets/:id:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: id
required: 1
summary: ~
type: string
summary: Delete a release asset
/repos/:owner/:repo/subscription:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Delete a Repository Subscription....
/teams/:teamId:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
summary: Delete team.
/teams/:teamId/members/:username:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
- name: username
required: 1
summary: Name of a member.
type: string
summary: The "Remove team member" API is deprecated and is ...
/teams/:teamId/memberships/:username:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
- name: username
required: 1
summary: Name of a member.
type: string
summary: Remove team membership.
/teams/:teamId/repos/:owner/:repo:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
- name: owner
required: 1
summary: Name of a repository owner.
type: string
- name: repo
required: 1
summary: Name of a repository.
type: string
summary: In order to remove a repository from a team, the a...
/user/emails:
options: []
parameters: []
summary: Delete email address(es).
/user/following/:username:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: Unfollow a user.
/user/keys/:keyId:
options: []
parameters:
- name: keyId
required: 1
summary: ID of key.
type: integer
summary: Delete a public key. Removes a public key. Require...
/user/starred/:owner/:repo:
options: []
parameters:
- name: owner
required: 1
summary: Name of a repository owner.
type: string
- name: repo
required: 1
summary: Name of a repository.
type: string
summary: Unstar a repository
/user/subscriptions/:owner/:repo:
options: []
parameters:
- name: owner
required: 1
summary: Name of the owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Stop watching a repository
summary: DELETE call
GET:
op: apicall
subcommands:
/emojis:
options: []
parameters: []
summary: Lists all the emojis available to use on GitHub....
/events:
examples/githubcl-appspec.yaml view on Meta::CPAN
options: []
parameters: []
summary: List Feeds.
/gists:
options:
- name: q-since
required: ~
summary: |
Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.
Only gists updated at or after this time are returned.
type: string
parameters: []
summary: List the authenticated user's gists or if called a...
/gists/:id:
options: []
parameters:
- name: id
required: 1
summary: Id of gist.
type: integer
summary: Get a single gist.
/gists/:id/comments:
options: []
parameters:
- name: id
required: 1
summary: Id of gist.
type: integer
summary: List comments on a gist.
/gists/:id/comments/:commentId:
options: []
parameters:
- name: id
required: 1
summary: Id of gist.
type: integer
- name: commentId
required: 1
summary: Id of comment.
type: integer
summary: Get a single comment.
/gists/:id/star:
options: []
parameters:
- name: id
required: 1
summary: Id of gist.
type: integer
summary: Check if a gist is starred.
/gists/public:
options:
- name: q-since
required: ~
summary: |
Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.
Only gists updated at or after this time are returned.
type: string
parameters: []
summary: List all public gists.
/gists/starred:
options:
- name: q-since
required: ~
summary: |
Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.
Only gists updated at or after this time are returned.
type: string
parameters: []
summary: List the authenticated user's starred gists....
/gitignore/templates:
options: []
parameters: []
summary: Listing available templates.
/gitignore/templates/:language:
options: []
parameters:
- name: language
required: 1
summary: ~
type: string
summary: Get a single template.
/issues:
options:
- enum: *1
name: q-filter
required: 1
summary: |
Issues assigned to you / created by you / mentioning you / you're
subscribed to updates for / All issues the authenticated user can see
type: string
- enum: *2
name: q-state
required: 1
summary: ~
type: string
- name: q-labels
required: 1
summary: String list of comma separated Label names. Example - bug,ui,@high.
type: string
- enum: *3
name: q-sort
required: 1
summary: ~
type: string
- enum: *4
name: q-direction
required: 1
summary: ~
type: string
- name: q-since
required: ~
summary: |
Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only issues updated at or after this time are returned.
type: string
parameters: []
summary: List issues.
/legacy/issues/search/:owner/:repository/:state/:keyword:
options: []
parameters:
- name: keyword
required: 1
summary: The search term.
type: string
- enum: *5
name: state
required: 1
summary: Indicates the state of the issues to return. Can be either open
or closed.
type: string
- name: owner
required: 1
summary: ~
type: string
- name: repository
required: 1
summary: ~
type: string
summary: Find issues by state and keyword....
/legacy/repos/search/:keyword:
options:
- enum: *6
name: q-order
required: ~
summary: The sort field. if sort param is provided. Can be either asc or
desc.
type: string
- name: q-language
required: ~
summary: Filter results by language
type: string
- name: q-start_page
required: ~
summary: The page number to fetch
type: string
- enum: *7
name: q-sort
required: ~
summary: 'The sort field. One of stars, forks, or updated. Default: results
are sorted by best match.'
type: string
parameters:
- name: keyword
required: 1
summary: The search term
type: string
summary: Find repositories by keyword. Note, this legacy me...
/legacy/user/email/:email:
options: []
parameters:
- name: email
required: 1
summary: The email address
type: string
summary: This API call is added for compatibility reasons o...
/legacy/user/search/:keyword:
options:
- enum: *8
name: q-order
required: ~
summary: The sort field. if sort param is provided. Can be either asc or
desc.
type: string
- name: q-start_page
required: ~
summary: The page number to fetch
type: string
- enum: *9
name: q-sort
required: ~
summary: 'The sort field. One of stars, forks, or updated. Default: results
are sorted by best match.'
type: string
parameters:
- name: keyword
required: 1
summary: The search term
type: string
summary: Find users by keyword.
/meta:
options: []
parameters: []
summary: This gives some information about GitHub.com, the ...
/networks/:owner/:repo/events:
options: []
parameters:
- name: owner
required: 1
summary: Name of the owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List public events for a network of repositories....
/notifications:
options:
- name: q-all
required: ~
summary: True to show notifications marked as read.
type: boolean
- name: q-participating
required: ~
summary: |
True to show only notifications in which the user is directly participating
or mentioned.
type: boolean
- name: q-since
required: ~
summary: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
type: string
parameters: []
summary: List your notifications.
/notifications/threads/:id:
options: []
parameters:
- name: id
required: 1
summary: Id of thread.
type: integer
summary: View a single thread.
/notifications/threads/:id/subscription:
options: []
parameters:
- name: id
required: 1
summary: Id of thread.
type: integer
summary: Get a Thread Subscription.
/orgs/:org:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: Get an Organization.
/orgs/:org/events:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: List public events for an organization....
/orgs/:org/issues:
options:
- enum: *10
name: q-filter
required: 1
summary: |
Issues assigned to you / created by you / mentioning you / you're
subscribed to updates for / All issues the authenticated user can see
type: string
- enum: *11
name: q-state
required: 1
summary: ~
type: string
- name: q-labels
required: 1
summary: String list of comma separated Label names. Example - bug,ui,@high.
type: string
- enum: *12
name: q-sort
required: 1
summary: ~
type: string
- enum: *13
name: q-direction
required: 1
summary: ~
type: string
- name: q-since
required: ~
summary: |
Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only issues updated at or after this time are returned.
type: string
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: List issues.
/orgs/:org/members:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: Members list.
/orgs/:org/members/:username:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
- name: username
required: 1
summary: Name of the user.
type: string
summary: Check if a user is, publicly or privately, a membe...
/orgs/:org/public_members:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: Public members list.
/orgs/:org/public_members/:username:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
- name: username
required: 1
summary: Name of the user.
type: string
summary: Check public membership.
/orgs/:org/repos:
options:
- enum: *14
name: q-type
required: ~
summary: ~
type: string
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: List repositories for the specified org....
/orgs/:org/teams:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: List teams.
/rate_limit:
options: []
parameters: []
summary: Get your current rate limit status...
/repos/:owner/:repo:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get repository.
/repos/:owner/:repo/:archive_format/:path:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- enum: *25
name: archive_format
required: 1
summary: ~
type: string
- name: path
required: 1
summary: Valid Git reference, defaults to 'master'.
type: string
summary: Get archive link.
/repos/:owner/:repo/assignees:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List assignees.
/repos/:owner/:repo/assignees/:assignee:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: assignee
required: 1
summary: Login of the assignee.
type: string
summary: Check assignee.
/repos/:owner/:repo/branches:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get list of branches
/repos/:owner/:repo/branches/:branch:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: branch
required: 1
summary: Name of the branch.
type: string
summary: Get Branch
/repos/:owner/:repo/collaborators:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List.
/repos/:owner/:repo/collaborators/:user:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: user
required: 1
summary: Login of the user.
type: string
summary: Check if user is a collaborator...
/repos/:owner/:repo/comments:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List commit comments for a repository....
/repos/:owner/:repo/comments/:commentId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: commentId
required: 1
summary: Id of comment.
type: integer
summary: Get a single commit comment.
/repos/:owner/:repo/commits:
options:
- name: q-since
required: ~
summary: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
type: string
- name: q-sha
required: ~
summary: Sha or branch to start listing commits from.
type: string
- name: q-path
required: ~
summary: Only commits containing this file path will be returned.
type: string
- name: q-author
required: ~
summary: GitHub login, name, or email by which to filter by commit author.
type: string
- name: q-until
required: ~
summary: ISO 8601 Date - Only commits before this date will be returned.
type: string
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List commits on a repository.
/repos/:owner/:repo/commits/:ref/status:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: ref
required: 1
summary: ~
type: string
summary: Get the combined Status for a specific Ref...
/repos/:owner/:repo/commits/:shaCode:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: shaCode
required: 1
summary: SHA-1 code of the commit.
type: string
summary: Get a single commit.
/repos/:owner/:repo/commits/:shaCode/comments:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: shaCode
required: 1
summary: SHA-1 code of the commit.
type: string
summary: List comments for a single commitList comments for...
/repos/:owner/:repo/compare/:baseId...:headId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: baseId
required: 1
summary: ~
type: string
- name: headId
required: 1
summary: ~
type: string
summary: Compare two commits
/repos/:owner/:repo/contents/:path:
options:
- name: q-path
required: ~
summary: The content path.
type: string
- name: q-ref
required: ~
summary: The String name of the Commit/Branch/Tag. Defaults to 'master'.
type: string
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: path
required: 1
summary: ~
type: string
summary: Get contents.
/repos/:owner/:repo/contributors:
options:
- name: q-anon
required: 1
summary: Set to 1 or true to include anonymous contributors in results.
type: string
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get list of contributors.
/repos/:owner/:repo/deployments:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Users with pull access can view deployments for a ...
/repos/:owner/:repo/deployments/:id/statuses:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: id
required: 1
summary: The Deployment ID to list the statuses from.
type: integer
summary: Users with pull access can view deployment statuse...
/repos/:owner/:repo/downloads:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Deprecated. List downloads for a repository....
/repos/:owner/:repo/downloads/:downloadId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: downloadId
required: 1
summary: Id of download.
type: integer
summary: Deprecated. Get a single download....
/repos/:owner/:repo/events:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get list of repository events.
/repos/:owner/:repo/forks:
options:
- enum: *15
name: q-sort
required: ~
summary: ~
type: string
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List forks.
/repos/:owner/:repo/git/blobs/:shaCode:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: shaCode
required: 1
summary: SHA-1 code.
type: string
summary: Get a Blob.
/repos/:owner/:repo/git/commits/:shaCode:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: shaCode
required: 1
summary: SHA-1 code.
type: string
summary: Get a Commit.
/repos/:owner/:repo/git/refs:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get all References
/repos/:owner/:repo/git/refs/:ref:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: ref
required: 1
summary: ~
type: string
summary: Get a Reference
/repos/:owner/:repo/git/tags/:shaCode:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: shaCode
required: 1
summary: ~
type: string
summary: Get a Tag.
/repos/:owner/:repo/git/trees/:shaCode:
options:
- name: q-recursive
required: ~
summary: Get a Tree Recursively. (0 or 1)
type: integer
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: shaCode
required: 1
summary: Tree SHA.
type: string
summary: Get a Tree.
/repos/:owner/:repo/hooks:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get list of hooks.
/repos/:owner/:repo/hooks/:hookId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: hookId
required: 1
summary: Id of hook.
type: integer
summary: Get single hook.
/repos/:owner/:repo/issues:
options:
- enum: *16
name: q-filter
required: 1
summary: |
Issues assigned to you / created by you / mentioning you / you're
subscribed to updates for / All issues the authenticated user can see
type: string
- enum: *17
name: q-state
required: 1
summary: ~
type: string
- name: q-labels
required: 1
summary: String list of comma separated Label names. Example - bug,ui,@high.
type: string
- enum: *18
name: q-sort
required: 1
summary: ~
type: string
- enum: *19
name: q-direction
required: 1
summary: ~
type: string
- name: q-since
required: ~
summary: |
Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only issues updated at or after this time are returned.
type: string
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List issues for a repository.
/repos/:owner/:repo/issues/:number:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Number of issue.
type: integer
summary: Get a single issue
/repos/:owner/:repo/issues/:number/comments:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Number of issue.
type: integer
summary: List comments on an issue.
/repos/:owner/:repo/issues/:number/events:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Number of issue.
type: integer
summary: List events for an issue.
/repos/:owner/:repo/issues/:number/labels:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Number of issue.
type: integer
summary: List labels on an issue.
/repos/:owner/:repo/issues/comments:
options:
- name: q-direction
required: ~
summary: Ignored without 'sort' parameter.
type: string
- enum: *20
name: q-sort
required: ~
summary: ''
type: string
- name: q-since
required: ~
summary: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
type: string
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List comments in a repository.
/repos/:owner/:repo/issues/comments/:commentId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: commentId
required: 1
summary: ID of comment.
type: integer
summary: Get a single comment.
/repos/:owner/:repo/issues/events:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List issue events for a repository....
/repos/:owner/:repo/issues/events/:eventId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: eventId
required: 1
summary: Id of the event.
type: integer
summary: Get a single event.
/repos/:owner/:repo/keys:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get list of keys.
/repos/:owner/:repo/keys/:keyId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: keyId
required: 1
summary: Id of key.
type: integer
summary: Get a key
/repos/:owner/:repo/labels:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List all labels for this repository....
/repos/:owner/:repo/labels/:name:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: name
required: 1
summary: Name of the label.
type: string
summary: Get a single label.
/repos/:owner/:repo/languages:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List languages.
/repos/:owner/:repo/milestones:
options:
- enum: *21
name: q-state
required: ~
summary: String to filter by state.
type: string
- name: q-direction
required: ~
summary: Ignored without 'sort' parameter.
type: string
- enum: *22
name: q-sort
required: ~
summary: ''
type: string
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List milestones for a repository....
/repos/:owner/:repo/milestones/:number:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Number of milestone.
type: integer
summary: Get a single milestone.
/repos/:owner/:repo/milestones/:number/labels:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Number of milestone.
type: integer
summary: Get labels for every issue in a milestone....
/repos/:owner/:repo/notifications:
options:
- name: q-all
required: ~
summary: True to show notifications marked as read.
type: boolean
- name: q-participating
required: ~
summary: |
True to show only notifications in which the user is directly participating
or mentioned.
type: boolean
- name: q-since
required: ~
summary: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
type: string
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List your notifications in a repository...
/repos/:owner/:repo/pulls:
options:
- enum: *23
name: q-state
required: ~
summary: String to filter by state.
type: string
- name: q-head
required: ~
summary: |
Filter pulls by head user and branch name in the format of 'user:ref-name'.
Example: github:new-script-format.
type: string
- name: q-base
required: ~
summary: Filter pulls by base branch name. Example - gh-pages.
type: string
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List pull requests.
/repos/:owner/:repo/pulls/:number:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Id of pull.
type: integer
summary: Get a single pull request.
/repos/:owner/:repo/pulls/:number/comments:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Id of pull.
type: integer
summary: List comments on a pull request....
/repos/:owner/:repo/pulls/:number/commits:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Id of pull.
type: integer
summary: List commits on a pull request....
/repos/:owner/:repo/pulls/:number/files:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Id of pull.
type: integer
summary: List pull requests files.
/repos/:owner/:repo/pulls/:number/merge:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Id of pull.
type: integer
summary: Get if a pull request has been merged....
/repos/:owner/:repo/pulls/comments:
options:
- name: q-direction
required: ~
summary: Ignored without 'sort' parameter.
type: string
- enum: *24
name: q-sort
required: ~
summary: ''
type: string
- name: q-since
required: ~
summary: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
type: string
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List comments in a repository.
/repos/:owner/:repo/pulls/comments/:commentId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: commentId
required: 1
summary: Id of comment.
type: integer
summary: Get a single comment.
/repos/:owner/:repo/readme:
options:
- name: q-ref
required: ~
summary: The String name of the Commit/Branch/Tag. Defaults to master.
type: string
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get the README.
/repos/:owner/:repo/releases:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Users with push access to the repository will rece...
/repos/:owner/:repo/releases/:id:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: id
required: 1
summary: ~
type: string
summary: Get a single release
/repos/:owner/:repo/releases/:id/assets:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: id
required: 1
summary: ~
type: string
summary: List assets for a release
/repos/:owner/:repo/releases/assets/:id:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: id
required: 1
summary: ~
type: string
summary: Get a single release asset
/repos/:owner/:repo/stargazers:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List Stargazers.
/repos/:owner/:repo/stats/code_frequency:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get the number of additions and deletions per week...
/repos/:owner/:repo/stats/commit_activity:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get the last year of commit activity data....
/repos/:owner/:repo/stats/contributors:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get contributors list with additions, deletions, a...
/repos/:owner/:repo/stats/participation:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get the weekly commit count for the repo owner and...
/repos/:owner/:repo/stats/punch_card:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get the number of commits per hour in each day....
/repos/:owner/:repo/statuses/:ref:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: ref
required: 1
summary: |
Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.
type: string
summary: List Statuses for a specific Ref....
/repos/:owner/:repo/subscribers:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List watchers.
/repos/:owner/:repo/subscription:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get a Repository Subscription.
/repos/:owner/:repo/tags:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get list of tags.
/repos/:owner/:repo/teams:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get list of teams
/repos/:owner/:repo/watchers:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List Stargazers. New implementation....
/repositories:
options:
- name: q-since
required: ~
summary: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
type: string
parameters: []
summary: List all public repositories.
/search/code:
options:
- enum: *26
name: q-order
required: ~
summary: The sort field. if sort param is provided. Can be either asc or
desc.
type: string
- name: q-q
required: 1
summary: |
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.
type: string
- enum: *27
name: q-sort
required: ~
summary: |
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.
type: string
parameters: []
summary: Search code.
/search/issues:
options:
- enum: *28
name: q-order
required: ~
summary: The sort field. if sort param is provided. Can be either asc or
desc.
type: string
- name: q-q
required: 1
summary: 'The q search term can also contain any combination of the supported
issue search qualifiers:'
type: string
- enum: *29
name: q-sort
required: ~
summary: 'The sort field. Can be comments, created, or updated. Default:
results are sorted by best match.'
type: string
parameters: []
summary: Find issues by state and keyword. (This method ret...
/search/repositories:
options:
- enum: *30
name: q-order
required: ~
summary: The sort field. if sort param is provided. Can be either asc or
desc.
type: string
- name: q-q
required: 1
summary: |
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.
type: string
- enum: *31
name: q-sort
required: ~
summary: If not provided, results are sorted by best match.
type: string
parameters: []
summary: Search repositories.
/search/users:
options:
- enum: *32
name: q-order
required: ~
summary: The sort field. if sort param is provided. Can be either asc or
desc.
type: string
- name: q-q
required: 1
summary: |
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.
type: string
- enum: *33
name: q-sort
required: ~
summary: If not provided, results are sorted by best match.
type: string
parameters: []
summary: Search users.
/teams/:teamId:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
summary: Get team.
/teams/:teamId/members:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
summary: List team members.
/teams/:teamId/members/:username:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
- name: username
required: 1
summary: Name of a member.
type: string
summary: The "Get team member" API is deprecated and is sch...
/teams/:teamId/memberships/:username:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
- name: username
required: 1
summary: Name of a member.
type: string
summary: Get team membership.
/teams/:teamId/repos:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
summary: List team repos
/teams/:teamId/repos/:owner/:repo:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
- name: owner
required: 1
summary: Name of a repository owner.
type: string
- name: repo
required: 1
summary: Name of a repository.
type: string
summary: Check if a team manages a repository...
/user:
options: []
parameters: []
summary: Get the authenticated user.
/user/emails:
options: []
parameters: []
summary: List email addresses for a user....
/user/followers:
examples/githubcl-appspec.yaml view on Meta::CPAN
/user/following:
options: []
parameters: []
summary: List who the authenticated user is following....
/user/following/:username:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: Check if you are following a user....
/user/issues:
options:
- enum: *34
name: q-filter
required: 1
summary: |
Issues assigned to you / created by you / mentioning you / you're
subscribed to updates for / All issues the authenticated user can see
type: string
- enum: *35
name: q-state
required: 1
summary: ~
type: string
- name: q-labels
required: 1
summary: String list of comma separated Label names. Example - bug,ui,@high.
type: string
- enum: *36
name: q-sort
required: 1
summary: ~
type: string
- enum: *37
name: q-direction
required: 1
summary: ~
type: string
- name: q-since
required: ~
summary: |
Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only issues updated at or after this time are returned.
type: string
parameters: []
summary: List issues.
/user/keys:
options: []
parameters: []
summary: List your public keys.
/user/keys/:keyId:
options: []
parameters:
- name: keyId
required: 1
summary: ID of key.
type: integer
summary: Get a single public key.
/user/orgs:
options: []
parameters: []
summary: List public and private organizations for the auth...
/user/repos:
options:
- enum: *38
name: q-type
required: ~
summary: ~
type: string
parameters: []
summary: List repositories for the authenticated user. Note...
/user/starred:
options:
- name: q-direction
required: ~
summary: Ignored without 'sort' parameter.
type: string
- enum: *39
name: q-sort
required: ~
summary: ''
type: string
parameters: []
summary: List repositories being starred by the authenticat...
/user/starred/:owner/:repo:
options: []
parameters:
- name: owner
required: 1
summary: Name of a repository owner.
type: string
- name: repo
required: 1
summary: Name of a repository.
type: string
summary: Check if you are starring a repository....
/user/subscriptions:
options: []
parameters: []
summary: List repositories being watched by the authenticat...
/user/subscriptions/:owner/:repo:
options: []
parameters:
- name: owner
required: 1
summary: Name of the owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Check if you are watching a repository....
/user/teams:
options: []
parameters: []
summary: List all of the teams across all of the organizati...
/users:
options:
- name: q-since
required: ~
summary: The integer ID of the last User that you've seen.
type: integer
parameters: []
summary: Get all users.
/users/:username:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: Get a single user.
/users/:username/events:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: If you are authenticated as the given user, you wi...
/users/:username/events/orgs/:org:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
- name: org
required: 1
summary: ~
type: string
summary: This is the user's organization dashboard. You mus...
/users/:username/followers:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List a user's followers
/users/:username/following/:targetUser:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
- name: targetUser
required: 1
summary: Name of user.
type: string
summary: Check if one user follows another....
/users/:username/gists:
options:
- name: q-since
required: ~
summary: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
type: string
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List a users gists.
/users/:username/keys:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List public keys for a user.
/users/:username/orgs:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List all public organizations for a user....
/users/:username/received_events:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: These are events that you'll only see public event...
/users/:username/received_events/public:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List public events that a user has received...
/users/:username/repos:
options:
- enum: *40
name: q-type
required: ~
summary: ~
type: string
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List public repositories for the specified user....
/users/:username/starred:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List repositories being starred by a user....
/users/:username/subscriptions:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List repositories being watched by a user....
summary: GET call
PATCH:
op: apicall
subcommands:
/gists/:id:
options: []
parameters:
- name: id
required: 1
summary: Id of gist.
type: integer
summary: Edit a gist.
/gists/:id/comments/:commentId:
options: []
parameters:
- name: id
required: 1
summary: Id of gist.
type: integer
- name: commentId
required: 1
summary: Id of comment.
type: integer
summary: Edit a comment.
/notifications/threads/:id:
options: []
parameters:
- name: id
required: 1
summary: Id of thread.
type: integer
summary: Mark a thread as read
/orgs/:org:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: Edit an Organization.
/repos/:owner/:repo:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Edit repository.
/repos/:owner/:repo/comments/:commentId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: commentId
required: 1
summary: Id of comment.
type: integer
summary: Update a commit comment.
/repos/:owner/:repo/git/refs/:ref:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: ref
required: 1
summary: ~
type: string
summary: Update a Reference
/repos/:owner/:repo/hooks/:hookId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: hookId
required: 1
summary: Id of hook.
type: integer
summary: Edit a hook.
/repos/:owner/:repo/issues/:number:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Number of issue.
type: integer
summary: Edit an issue.
/repos/:owner/:repo/issues/comments/:commentId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: commentId
required: 1
summary: ID of comment.
type: integer
summary: Edit a comment.
/repos/:owner/:repo/labels/:name:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: name
required: 1
summary: Name of the label.
type: string
summary: Update a label.
/repos/:owner/:repo/milestones/:number:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Number of milestone.
type: integer
summary: Update a milestone.
/repos/:owner/:repo/pulls/:number:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Id of pull.
type: integer
summary: Update a pull request.
/repos/:owner/:repo/pulls/comments/:commentId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: commentId
required: 1
summary: Id of comment.
type: integer
summary: Edit a comment.
/repos/:owner/:repo/releases/:id:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: id
required: 1
summary: ~
type: string
summary: Users with push access to the repository can edit ...
/repos/:owner/:repo/releases/assets/:id:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: id
required: 1
summary: ~
type: string
summary: Edit a release asset
/teams/:teamId:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
summary: Edit team.
/user:
options: []
parameters: []
summary: Update the authenticated user.
summary: PATCH call
POST:
op: apicall
subcommands:
/gists:
options: []
parameters: []
summary: Create a gist.
/gists/:id/comments:
options: []
parameters:
- name: id
required: 1
summary: Id of gist.
type: integer
summary: Create a commen
/gists/:id/forks:
options: []
parameters:
- name: id
required: 1
summary: Id of gist.
type: integer
summary: Fork a gist.
/markdown:
options: []
parameters: []
summary: Render an arbitrary Markdown document...
/markdown/raw:
options: []
parameters: []
summary: Render a Markdown document in raw mode...
/orgs/:org/repos:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: Create a new repository for the authenticated user...
/orgs/:org/teams:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: Create team.
/repos/:owner/:repo/commits/:shaCode/comments:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: shaCode
required: 1
summary: SHA-1 code of the commit.
type: string
summary: Create a commit comment.
/repos/:owner/:repo/deployments:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Users with push access can create a deployment for...
/repos/:owner/:repo/deployments/:id/statuses:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: id
required: 1
summary: The Deployment ID to list the statuses from.
type: integer
summary: Create a Deployment Status
/repos/:owner/:repo/forks:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Create a fork.
/repos/:owner/:repo/git/blobs:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Create a Blob.
/repos/:owner/:repo/git/commits:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Create a Commit.
/repos/:owner/:repo/git/refs:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Create a Reference
/repos/:owner/:repo/git/tags:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Create a Tag Object.
/repos/:owner/:repo/git/trees:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Create a Tree.
/repos/:owner/:repo/hooks:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Create a hook.
/repos/:owner/:repo/hooks/:hookId/tests:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: hookId
required: 1
summary: Id of hook.
type: integer
summary: Test a push hook.
/repos/:owner/:repo/issues:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Create an issue.
/repos/:owner/:repo/issues/:number/comments:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Number of issue.
type: integer
summary: Create a comment.
/repos/:owner/:repo/issues/:number/labels:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Number of issue.
type: integer
summary: Add labels to an issue.
/repos/:owner/:repo/keys:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Create a key.
/repos/:owner/:repo/labels:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Create a label.
/repos/:owner/:repo/merges:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Perform a merge.
/repos/:owner/:repo/milestones:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Create a milestone.
/repos/:owner/:repo/pulls:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Create a pull request.
/repos/:owner/:repo/pulls/:number/comments:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Id of pull.
type: integer
summary: Create a comment.
/repos/:owner/:repo/releases:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Create a release
/repos/:owner/:repo/statuses/:ref:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: ref
required: 1
summary: |
Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.
type: string
summary: Create a Status.
/user/emails:
options: []
parameters: []
summary: Add email address(es).
/user/keys:
options: []
parameters: []
summary: Create a public key.
/user/repos:
examples/githubcl-appspec.yaml view on Meta::CPAN
summary: POST call
PUT:
op: apicall
subcommands:
/gists/:id/star:
options: []
parameters:
- name: id
required: 1
summary: Id of gist.
type: integer
summary: Star a gist.
/notifications:
options: []
parameters: []
summary: Mark as read.
/notifications/threads/:id/subscription:
options: []
parameters:
- name: id
required: 1
summary: Id of thread.
type: integer
summary: Set a Thread Subscription.
/orgs/:org/public_members/:username:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
- name: username
required: 1
summary: Name of the user.
type: string
summary: Publicize a user's membership.
/repos/:owner/:repo/collaborators/:user:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: user
required: 1
summary: Login of the user.
type: string
summary: Add collaborator.
/repos/:owner/:repo/contents/:path:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: path
required: 1
summary: ~
type: string
summary: Create a file.
/repos/:owner/:repo/issues/:number/labels:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Number of issue.
type: integer
summary: Replace all labels for an issue....
/repos/:owner/:repo/notifications:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Mark notifications as read in a repository....
/repos/:owner/:repo/pulls/:number/merge:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Id of pull.
type: integer
summary: Merge a pull request (Merge Button's)...
/repos/:owner/:repo/subscription:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Set a Repository Subscription
/teams/:teamId/members/:username:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
- name: username
required: 1
summary: Name of a member.
type: string
summary: The API (described below) is deprecated and is sch...
/teams/:teamId/memberships/:username:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
- name: username
required: 1
summary: Name of a member.
type: string
summary: Add team membership.
/teams/:teamId/repos/:org/:repo:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
- name: org
required: 1
summary: Name of a organization.
type: string
- name: repo
required: 1
summary: Name of a repository.
type: string
summary: In order to add a repository to a team, the authen...
/user/following/:username:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: Follow a user.
/user/starred/:owner/:repo:
options: []
parameters:
- name: owner
required: 1
summary: Name of a repository owner.
type: string
- name: repo
required: 1
summary: Name of a repository.
type: string
summary: Star a repository.
/user/subscriptions/:owner/:repo:
options: []
parameters:
- name: owner
required: 1
summary: Name of the owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Watch a repository.
summary: PUT call
summary: |
Powerful collaboration, code review, and code management for open source and private projects.
title: GitHub
examples/githubcl-openapi.yaml view on Meta::CPAN
- 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: ''
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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:
examples/githubcl-openapi.yaml view on Meta::CPAN
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
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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':
examples/githubcl-openapi.yaml view on Meta::CPAN
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
examples/githubcl-openapi.yaml view on Meta::CPAN
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
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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':
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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':
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
'/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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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:
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
'/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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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':
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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}':
examples/githubcl-openapi.yaml view on Meta::CPAN
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: |
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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}':
examples/githubcl-openapi.yaml view on Meta::CPAN
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:
examples/githubcl-openapi.yaml view on Meta::CPAN
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:
examples/githubcl-openapi.yaml view on Meta::CPAN
'/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':
examples/githubcl-openapi.yaml view on Meta::CPAN
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':
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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: |
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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:
examples/githubcl-openapi.yaml view on Meta::CPAN
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'
examples/githubcl-openapi.yaml view on Meta::CPAN
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
type: array
assignees:
items:
properties:
avatar_url:
type: integer
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
blob:
properties:
content:
type: string
encoding:
enum:
- utf-8
- base64
sha:
type: string
size:
type: integer
type: object
blobs:
properties:
sha:
type: string
type: object
branch:
properties:
_links:
properties:
html:
type: string
self:
type: string
type: object
commit:
properties:
author:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
commit:
properties:
author:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
committer:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
committer:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
url:
type: string
type: object
name:
type: string
type: object
branches:
items:
properties:
commit:
properties:
sha:
type: string
url:
type: string
type: object
name:
type: string
type: object
type: array
codeFrequencyStats:
items:
type: integer
type: array
collaborators:
items:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
comment:
properties:
body:
type: string
type: object
commentBody:
properties:
body:
type: string
required:
- body
type: object
comments:
items:
properties:
body:
type: string
created_at:
description: ISO 8601.
type: string
id:
type: integer
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
commit:
properties:
author:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
commit:
properties:
author:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
committer:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
committer:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
files:
items:
properties:
additions:
type: integer
blob_url:
type: string
changes:
type: integer
deletions:
type: integer
filename:
type: string
patch:
type: string
raw_url:
type: string
status:
type: string
type: object
type: array
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
stats:
properties:
additions:
type: integer
deletions:
type: integer
total:
type: integer
type: object
url:
type: string
type: object
commitActivityStats:
items:
properties:
days:
items:
type: integer
type: array
total:
type: integer
week:
type: integer
type: object
type: array
commitBody:
properties:
body:
type: string
line:
description: Deprecated - Use position parameter instead.
type: string
number:
description: Line number in the file to comment on. Defaults to null.
type: string
path:
description: Relative path of the file to comment on.
type: string
position:
description: Line index in the diff to comment on.
type: integer
sha:
description: SHA of the commit to comment on.
type: string
required:
- sha
- body
type: object
commitComments:
properties:
body:
type: string
commit_id:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
html_url:
type: string
id:
type: integer
line:
type: integer
path:
type: string
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
commits:
items:
properties:
author:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
commit:
properties:
author:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
committer:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
committer:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
url:
type: string
type: object
type: array
compare-commits:
properties:
ahead_by:
type: integer
base_commit:
properties:
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
commit:
properties:
author:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
committer:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
committer:
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
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
url:
type: string
type: object
behind_by:
type: integer
commits:
items:
properties:
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
commit:
properties:
author:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
committer:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
committer:
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
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
url:
type: string
type: object
type: array
diff_url:
type: string
files:
items:
properties:
additions:
type: integer
blob_url:
type: string
changes:
type: integer
contents_url:
type: string
deletions:
type: integer
filename:
type: string
patch:
type: string
raw_url:
type: string
sha:
type: string
status:
type: string
type: object
type: array
html_url:
type: string
patch_url:
type: string
permalink_url:
type: string
status:
type: string
total_commits:
type: integer
url:
type: string
type: object
contents-path:
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
contributors:
items:
properties:
avatar_url:
type: string
contributions:
type: integer
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
contributorsStats:
items:
properties:
author:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
total:
description: The Total number of commits authored by the contributor.
type: integer
weeks:
items:
properties:
a:
description: Number of additions.
type: integer
c:
description: Number of commits.
type: integer
d:
description: Number of deletions.
type: integer
w:
description: Start of the week.
type: string
type: object
type: array
type: object
type: array
createDownload:
properties:
accesskeyid:
type: string
acl:
type: string
bucket:
type: string
content_type:
type: string
description:
type: string
download_count:
type: integer
expirationdate:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
html_url:
type: string
id:
type: integer
mime_type:
type: string
name:
type: string
path:
type: string
policy:
type: string
prefix:
type: string
redirect:
type: boolean
s3_url:
type: string
signature:
type: string
size:
type: integer
url:
type: string
type: object
createFile:
properties:
commit:
properties:
author:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
committer:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
html_url:
type: string
message:
type: string
parents:
items:
properties:
html_url:
type: string
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
content:
properties:
_links:
properties:
git:
type: string
html:
type: string
self:
type: string
type: object
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
type: object
createFileBody:
properties:
committer:
properties:
email:
type: string
name:
type: string
type: object
content:
type: string
message:
type: string
type: object
deleteFile:
properties:
commit:
properties:
author:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
committer:
properties:
date:
type: string
email:
type: string
name:
type: string
html_url:
type: string
message:
type: string
parents:
properties:
html_url:
type: string
sha:
type: string
url:
type: string
type: object
sha:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
content:
type: string
type: object
deleteFileBody:
properties:
committer:
properties:
email:
type: string
name:
type: string
type: object
message:
type: string
sha:
type: string
type: object
deployment:
properties:
description:
type: string
payload:
properties:
deploy_user:
type: string
environment:
type: string
room_id:
type: number
type: object
ref:
type: string
type: object
deployment-resp:
properties:
created_at:
type: string
creator:
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
description:
type: string
id:
type: integer
payload:
type: string
sha:
type: string
statuses_url:
type: string
updated_at:
type: string
url:
type: string
type: object
deployment-statuses:
items:
properties:
created_at:
type: string
creator:
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
description:
type: string
id:
type: integer
payload:
type: string
state:
type: string
target_url:
type: string
updated_at:
type: string
url:
type: string
type: object
type: array
deployment-statuses-create:
properties:
description:
type: string
state:
type: string
target_url:
type: string
type: object
downloadBody:
properties:
content_type:
type: string
description:
type: string
name:
type: string
size:
description: Size of file in bytes.
type: integer
required:
- name
- size
type: object
downloads:
properties:
content_type:
type: string
description:
type: string
download_count:
type: integer
html_url:
type: string
id:
type: integer
name:
type: string
size:
type: integer
url:
type: string
type: object
editTeam:
properties:
name:
type: string
permission:
enum:
- pull
- push
- admin
required:
- name
type: object
emailsPost:
items:
type: string
type: array
emojis:
properties:
'100':
type: string
'1234':
type: string
'+1':
type: string
'-1':
type: string
8ball:
type: string
a:
type: string
ab:
type: string
type: object
event:
properties:
actor:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
commit_id:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
event:
type: string
issue:
properties:
assignee:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
body:
type: string
closed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
comments:
type: integer
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
html_url:
type: string
labels:
items:
properties:
color:
type: string
name:
type: string
url:
type: string
type: object
type: array
milestone:
properties:
closed_issues:
type: integer
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
due_on:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
number:
type: integer
open_issues:
type: integer
state:
enum:
- open
- closed
title:
type: string
url:
type: string
type: object
number:
type: integer
pull_request:
properties:
diff_url:
type: string
html_url:
type: string
patch_url:
type: string
type: object
state:
enum:
- open
- closed
title:
type: string
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
url:
type: string
type: object
events:
properties:
actor:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
created_at:
type: object
id:
type: integer
org:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
payload:
properties: {}
type: object
public:
type: boolean
repo:
properties:
id:
type: integer
name:
type: string
url:
type: string
type: object
type:
type: string
type: object
feeds:
properties:
_links:
properties:
current_user:
properties:
href:
type: string
type:
type: string
type: object
current_user_actor:
properties:
href:
type: string
type:
type: string
type: object
current_user_organization:
properties:
href:
type: string
type:
type: string
type: object
current_user_public:
properties:
href:
type: string
type:
type: string
type: object
timeline:
properties:
href:
type: string
type:
type: string
type: object
user:
properties:
href:
type: string
type:
type: string
type: object
current_user_actor_url:
type: string
current_user_organization_url:
type: string
current_user_public:
type: string
current_user_url:
type: string
timeline_url:
type: string
user_url:
type: string
type: object
fork:
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
forkBody:
properties:
organization:
type: string
type: object
forks:
items:
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
type: array
gist:
properties:
comments:
type: integer
comments_url:
type: string
created_at:
description: 'Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.'
type: string
description:
type: string
files:
properties:
ring.erl:
properties:
filename:
type: string
raw_url:
type: string
size:
type: integer
type: object
type: object
forks:
items:
properties:
created_at:
description: 'Timestamp in 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
git_pull_url:
type: string
git_push_url:
type: string
history:
items:
properties:
change_status:
properties:
additions:
type: integer
deletions:
type: integer
total:
type: integer
type: object
committed_at:
description: 'Timestamp in 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
version:
type: string
type: object
type: array
html_url:
type: string
id:
type: string
public:
type: boolean
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
gists:
items:
properties:
comments:
type: integer
comments_url:
type: string
created_at:
type: string
description:
type: string
files:
properties:
ring.erl:
properties:
filename:
type: string
raw_url:
type: string
size:
type: integer
type: object
type: object
git_pull_url:
type: string
git_push_url:
type: string
html_url:
type: string
id:
type: string
public:
type: boolean
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
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:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
type: object
type: array
hookBody:
properties:
active:
type: boolean
add_events:
items:
type: string
type: array
type: object
issue:
properties:
assignee:
type: string
body:
type: string
labels:
items:
type: string
type: array
milestone:
type: number
title:
type: string
type: object
issueBody:
properties:
assignee:
type: string
body:
type: string
labels:
items:
type: string
type: array
milestone:
type: number
title:
type: string
type: object
issues:
items:
properties:
assignee:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
body:
type: string
closed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
comments:
type: integer
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
html_url:
type: string
labels:
items:
properties:
color:
type: string
name:
type: string
url:
type: string
type: object
type: array
milestone:
properties:
closed_issues:
type: integer
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
due_on:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
number:
type: integer
open_issues:
type: integer
state:
enum:
- open
- closed
title:
type: string
url:
type: string
type: object
number:
type: integer
pull_request:
properties:
diff_url:
type: string
html_url:
type: string
patch_url:
type: string
type: object
state:
enum:
- open
- closed
title:
type: string
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
issuesComment:
properties:
body:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
html_url:
type: string
id:
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
issuesComments:
items:
properties:
_links:
properties:
html:
properties:
href:
type: string
type: object
pull_request:
properties:
href:
type: string
type: object
self:
properties:
href:
type: string
type: object
type: object
body:
type: string
commit_id:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
id:
type: integer
path:
type: string
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
key:
properties:
id:
type: integer
key:
type: string
title:
type: string
url:
type: string
type: object
keyBody:
properties:
key:
type: string
title:
type: string
type: object
keys:
items:
properties:
id:
type: integer
key:
type: string
title:
type: string
url:
type: string
type: object
type: array
label:
properties:
color:
maxLength: 6
minLength: 6
type: string
name:
type: string
url:
type: string
type: object
labels:
items:
properties:
color:
maxLength: 6
minLength: 6
type: string
name:
type: string
url:
type: string
type: object
type: array
labelsBody:
items:
type: string
type: array
languages:
additionalProperties:
type: integer
type: object
markdown:
properties:
context:
type: string
mode:
type: string
text:
type: string
type: object
members:
items:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
merge:
properties:
merged:
type: boolean
message:
type: string
sha:
type: string
type: object
mergePullBody:
properties:
commit_message:
type: string
type: object
mergesBody:
properties:
base:
type: string
commit_message:
type: string
head:
type: string
type: object
mergesConflict:
properties:
message:
description: Error message
type: string
type: object
mergesSuccessful:
properties:
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
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
comments_url:
type: string
commit:
properties:
author:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
comment_count:
type: integer
committer:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
committer:
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
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
merged:
type: boolean
message:
type: string
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
url:
type: string
type: object
meta:
properties:
git:
items:
description: An Array of IP addresses in CIDR format specifying the Git servers at GitHub.
type: string
type: array
hooks:
items:
description: An Array of IP addresses in CIDR format specifying the addresses that incoming service hooks will originate from.
type: string
type: array
type: object
milestone:
properties:
closed_issues:
type: integer
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
due_on:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
number:
type: integer
open_issues:
type: integer
state:
enum:
- open
- closed
title:
type: string
url:
type: string
type: object
milestoneBody:
properties:
description:
type: string
due_on:
type: string
state:
type: string
title:
type: string
type: object
milestoneUpdate:
properties:
description:
type: string
due_on:
type: string
state:
type: string
title:
type: string
type: object
notificationMarkRead:
properties:
last_read_at:
type: string
type: object
notifications:
properties:
id:
type: integer
last_read_at:
type: string
reason:
type: string
repository:
properties:
description:
type: string
fork:
type: boolean
full_name:
type: string
html_url:
type: string
id:
type: integer
name:
type: string
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
url:
type: string
type: object
subject:
properties:
latest_comment_url:
type: string
title:
type: string
type:
type: string
url:
type: string
type: object
unread:
type: boolean
updated_at:
type: string
url:
type: string
type: object
orgMembers:
items:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
orgPublicMembers:
items:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
orgTeams:
items:
properties:
id:
type: integer
name:
type: string
url:
type: string
type: object
type: array
orgTeamsPost:
properties:
name:
type: string
permission:
enum:
- pull
- push
- admin
repo_names:
items:
type: string
type: array
required:
- name
type: object
organization:
properties:
avatar_url:
type: string
blog:
type: string
company:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
followers:
type: integer
following:
type: integer
html_url:
type: string
id:
type: integer
location:
type: string
login:
type: string
name:
type: string
public_gists:
type: integer
public_repos:
type: integer
type:
type: string
url:
type: string
type: object
organizationAsTeamMember:
properties:
errors:
items:
properties:
code:
type: string
field:
type: string
resource:
type: string
type: object
type: array
message:
type: string
type: object
participationStats:
properties:
all:
items:
type: integer
type: array
owner:
items:
type: integer
type: array
type: object
patchGist:
properties:
description:
type: string
files:
properties:
delete_this_file.txt:
type: string
file1.txt:
properties:
content:
type: string
type: object
new_file.txt:
properties:
content:
type: string
type: object
old_name.txt:
properties:
content:
type: string
filename:
type: string
type: object
type: object
patchOrg:
properties:
billing_email:
description: Billing email address. This address is not publicized.
type: string
company:
type: string
email:
description: Publicly visible email address.
type: string
location:
type: string
name:
type: string
type: object
postComment:
properties:
body:
type: string
required:
- body
type: object
postGist:
properties:
description:
type: string
files:
properties:
file1.txt:
properties:
content:
type: string
type: object
type: object
public:
type: boolean
type: object
postRepo:
properties:
auto_init:
description: True to create an initial commit with empty README. Default is false.
type: boolean
description:
type: string
gitignore_template:
description: 'Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell" Ignored if auto_init parameter is not provided. '
type: string
has_downloads:
description: 'True to enable downloads for this repository, false to disable them. Default is true.'
type: boolean
has_issues:
description: 'True to enable issues for this repository, false to disable them. Default is true.'
type: boolean
has_wiki:
description: 'True to enable the wiki for this repository, false to disable it. Default is true.'
type: boolean
homepage:
type: string
name:
type: string
private:
description: 'True to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account.'
type: boolean
team_id:
description: The id of the team that will be granted access to this repository. This is only valid when creating a repo in an organization.
type: integer
required:
- name
type: object
pullRequest:
properties:
_links:
properties:
comments:
properties:
href:
type: string
type: object
html:
properties:
href:
type: string
type: object
review_comments:
properties:
href:
type: string
type: object
self:
properties:
href:
type: string
type: object
type: object
additions:
type: integer
base:
properties:
label:
type: string
ref:
type: string
repo:
properties:
clone_url:
type: string
created_at:
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: 'null'
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
sha:
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
body:
type: string
changed_files:
type: integer
closed_at:
type: string
comments:
type: integer
commits:
type: integer
created_at:
type: string
deletions:
type: integer
diff_url:
type: string
head:
properties:
label:
type: string
ref:
type: string
repo:
properties:
clone_url:
type: string
created_at:
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: 'null'
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
sha:
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
html_url:
type: string
issue_url:
type: string
merge_commit_sha:
type: string
mergeable:
type: boolean
merged:
type: boolean
merged_at:
type: string
merged_by:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
number:
type: integer
patch_url:
type: string
state:
type: string
title:
type: string
updated_at:
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
pullUpdate:
properties:
body:
type: string
state:
type: string
title:
type: string
type: object
pulls:
items:
properties:
_links:
properties:
comments:
properties:
href:
type: string
type: object
html:
properties:
href:
type: string
type: object
review_comments:
properties:
href:
type: string
type: object
self:
properties:
href:
type: string
type: object
type: object
base:
properties:
label:
type: string
ref:
type: string
repo:
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
sha:
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
body:
type: string
closed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
diff_url:
type: string
head:
properties:
label:
type: string
ref:
type: string
repo:
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
sha:
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
html_url:
type: string
issue_url:
type: string
merged_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
number:
type: integer
patch_url:
type: string
state:
enum:
- open
- closed
title:
type: string
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
pullsComment:
properties:
_links:
properties:
html:
properties:
href:
type: string
type: object
pull_request:
properties:
href:
type: string
type: object
self:
properties:
href:
type: string
type: object
type: object
body:
type: string
commit_id:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
id:
type: integer
path:
type: string
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
pullsCommentPost:
properties:
body:
type: string
commit_id:
type: string
path:
type: string
position:
type: number
type: object
pullsComments:
items:
properties:
_links:
properties:
html:
properties:
href:
type: string
type: object
pull_request:
properties:
href:
type: string
type: object
self:
properties:
href:
type: string
type: object
type: object
body:
type: string
commit_id:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
id:
type: integer
path:
type: string
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:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
type: object
type: array
refBody:
properties:
object:
properties:
sha:
type: string
type:
type: string
url:
type: string
type: object
ref:
type: string
url:
type: string
type: object
refStatus:
items:
properties:
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
upload_url:
type: string
url:
type: string
zipball_url:
type: string
type: object
type: array
repo:
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
has_downloads:
type: boolean
has_issues:
type: boolean
has_wiki:
type: boolean
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
organization:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
type:
type: string
url:
type: string
type: object
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
parent:
description: Is present when the repo is a fork. Parent is the repo this repo was forked from.
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
source:
description: Is present when the repo is a fork. Source is the ultimate source for the network.
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
repo-deployments:
items:
properties:
created_at:
type: string
creator:
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
description:
type: string
id:
type: integer
payload:
type: string
sha:
type: string
statuses_url:
type: string
updated_at:
type: string
url:
type: string
type: object
type: array
repoComments:
items:
properties:
body:
type: string
commit_id:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
html_url:
type: string
id:
type: integer
line:
type: integer
path:
type: string
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
repoCommit:
properties:
author:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
committer:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
repoCommitBody:
properties:
author:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
parents:
items:
type: string
type: array
tree:
type: string
required:
- message
- parents
- tree
type: object
repoEdit:
properties:
description:
type: string
has_downloads:
type: boolean
has_issues:
type: boolean
has_wiki:
type: boolean
homepage:
type: string
name:
type: string
private:
type: boolean
type: object
repos:
items:
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: array
repositories:
items:
properties:
description:
type: string
fork:
type: boolean
full_name:
type: string
html_url:
type: string
id:
type: integer
name:
type: string
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
url:
type: string
type: object
type: array
search-code:
properties:
items:
items:
properties:
git_url:
type: string
html_url:
type: string
name:
type: string
path:
type: string
repository:
properties:
archive_url:
type: string
assignees_url:
type: string
blobs_url:
type: string
branches_url:
type: string
collaborators_url:
type: string
comments_url:
type: string
commits_url:
type: string
compare_url:
type: string
contents_url:
type: string
contributors_url:
type: string
description:
type: string
downloads_url:
type: string
events_url:
type: string
fork:
type: boolean
forks_url:
type: string
full_name:
type: string
git_commits_url:
type: string
git_refs_url:
type: string
git_tags_url:
type: string
hooks_url:
type: string
html_url:
type: string
id:
type: integer
issue_comment_url:
type: string
issue_events_url:
type: string
issues_url:
type: string
keys_url:
type: string
labels_url:
type: string
languages_url:
type: string
merges_url:
type: string
milestones_url:
type: string
name:
type: string
notifications_url:
type: string
owner:
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
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
private:
type: boolean
pulls_url:
type: string
stargazers_url:
type: string
statuses_url:
type: string
subscribers_url:
type: string
subscription_url:
type: string
tags_url:
type: string
teams_url:
type: string
trees_url:
type: string
url:
type: string
type: object
score:
type: number
sha:
type: string
url:
type: string
type: object
type: array
total_count:
type: integer
type: object
search-issues:
properties:
items:
items:
properties:
assignee:
type: 'null'
body:
type: string
closed_at:
type: 'null'
comments:
type: integer
comments_url:
type: string
created_at:
type: string
events_url:
type: string
html_url:
type: string
id:
type: integer
labels:
items:
properties:
color:
type: string
name:
type: string
url:
type: string
type: object
type: array
labels_url:
type: string
milestone:
type: 'null'
number:
type: integer
pull_request:
properties:
diff_url:
type: 'null'
html_url:
type: 'null'
patch_url:
type: 'null'
type: object
score:
type: number
state:
type: string
title:
type: string
updated_at:
type: string
url:
type: string
user:
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
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
type: object
type: array
total_count:
type: integer
type: object
search-issues-by-keyword:
properties:
issues:
items:
properties:
body:
type: string
comments:
type: integer
created_at:
type: string
gravatar_id:
type: string
html_url:
type: string
labels:
items:
type: string
type: array
number:
type: integer
position:
type: integer
state:
type: string
title:
type: string
updated_at:
type: string
user:
type: string
votes:
type: integer
type: object
type: array
type: object
search-repositories:
properties:
items:
items:
properties:
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
default_branch:
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
received_events_url:
type: string
type:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
score:
type: number
size:
type: integer
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
type: array
total_count:
type: integer
type: object
search-repositories-by-keyword:
properties:
repositories:
items:
properties:
created:
type: string
created_at:
type: string
description:
type: string
followers:
type: integer
fork:
type: boolean
forks:
type: integer
has_downloads:
type: boolean
has_issues:
type: boolean
has_wiki:
type: boolean
homepage:
type: string
language:
type: string
name:
type: string
open_issues:
type: integer
owner:
type: string
private:
type: boolean
pushed:
type: string
pushed_at:
type: string
score:
type: number
size:
type: integer
type:
type: string
url:
type: string
username:
type: string
watchers:
type: integer
type: object
type: array
type: object
search-user-by-email:
properties:
user:
properties:
blog:
type: string
company:
type: string
created:
type: string
created_at:
type: string
email:
type: string
followers_count:
type: integer
following_count:
type: integer
gravatar_id:
type: string
id:
type: integer
location:
type: string
login:
type: string
name:
type: string
public_gist_count:
type: integer
public_repo_count:
type: integer
type:
type: string
type: object
type: object
search-users:
properties:
items:
items:
properties:
avatar_url:
type: string
followers_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
score:
type: number
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
type: array
total_count:
type: integer
type: object
search-users-by-keyword:
properties:
users:
items:
properties:
created:
type: string
created_at:
type: string
followers:
type: integer
followers_count:
type: integer
fullname:
type: string
gravatar_id:
type: string
id:
type: string
language:
type: string
location:
type: string
login:
type: string
name:
type: string
public_repo_count:
type: integer
repos:
type: integer
score:
type: number
type:
type: string
username:
type: string
type: object
type: array
type: object
stargazers:
items:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
subscribition:
properties:
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
ignored:
type: boolean
reason:
type: string
repository_url:
type: string
subscribed:
type: boolean
url:
type: string
type: object
subscribitionBody:
properties:
ignored:
type: boolean
subscribed:
type: boolean
type: object
subscription:
properties:
created_at:
type: string
ignored:
type: boolean
reason:
type: boolean
subscribed:
type: boolean
thread_url:
type: string
url:
type: string
type: object
tag:
properties:
message:
type: string
object:
properties:
sha:
type: string
type:
type: string
url:
type: string
type: object
sha:
type: string
tag:
type: string
tagger:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
url:
type: string
type: object
tags:
properties:
message:
description: String of the tag message.
type: string
object:
description: String of the SHA of the git object this is tagging.
type: string
tag:
type: string
tagger:
properties:
date:
description: Timestamp of when this object was tagged.
type: string
email:
description: String of the email of the author of the tag.
type: string
name:
description: String of the name of the author of the tag.
type: string
type: object
type:
description: String of the type of the object we’re tagging. Normally this is a commit but it can also be a tree or a blob.
type: string
required:
- tag
- message
- object
- type
- tagger
type: object
team:
properties:
id:
type: integer
members_count:
type: integer
name:
type: string
permission:
type: string
repos_count:
type: integer
url:
type: string
type: object
teamMembership:
properties:
state:
type: string
url:
type: string
type: object
teamRepos:
items:
properties:
clone_url:
type: string
created_at:
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: 'null'
master_branch:
type: string
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
type: array
teams:
items:
properties:
id:
type: integer
name:
type: string
url:
type: string
type: object
type: array
teams-list:
items:
properties:
id:
type: integer
members_count:
type: integer
name:
type: string
organization:
properties:
avatar_url:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
permission:
type: string
repos_count:
type: integer
url:
type: string
type: object
type: array
tree:
properties:
sha:
type: string
tree:
items:
properties:
mode:
type: string
path:
type: string
sha:
type: string
size:
type: integer
type:
type: string
url:
type: string
type: object
type: array
url:
type: string
type: object
trees:
properties:
base_tree:
type: string
sha:
description: SHA1 checksum ID of the object in the tree.
type: string
tree:
items:
properties:
mode:
description: 'One of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit) or 120000 for a blob that specifies the path of a symlink.'
enum:
- '100644'
- '100755'
- '040000'
- '160000'
- '120000'
type: string
path:
type: string
sha:
description: SHA1 checksum ID of the object in the tree.
type: string
type:
enum:
- blob
- tree
- commit
type: string
url:
type: string
type: object
type: array
url:
type: string
type: object
user:
properties:
avatar_url:
type: string
bio:
type: string
blog:
type: string
collaborators:
type: integer
company:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
disk_usage:
type: integer
email:
type: string
followers:
type: integer
following:
type: integer
gravatar_id:
type: string
hireable:
type: boolean
html_url:
type: string
id:
type: integer
location:
type: string
login:
type: string
name:
type: string
owned_private_repos:
type: integer
plan:
properties:
collaborators:
type: integer
name:
type: string
private_repos:
type: integer
space:
type: integer
type: object
private_gists:
type: integer
public_gists:
type: integer
public_repos:
type: integer
total_private_repos:
type: integer
type:
type: string
url:
type: string
type: object
user-emails:
items:
type: string
type: array
user-emails_final:
items: {}
type: array
user-keys:
items: {}
type: array
user-keys-keyId:
properties:
id:
type: integer
key:
type: string
title:
type: string
url:
type: string
type: object
user-keys-post:
properties:
key:
type: string
title:
type: string
type: object
user-update:
properties:
bio:
type: string
blog:
type: string
company:
type: string
email:
type: string
hireable:
type: boolean
location:
type: string
name:
type: string
type: object
user-userId:
properties:
avatar_url:
type: string
bio:
type: string
blog:
type: string
company:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
description: 'Note: The returned email is the user’s publicly visible email address (or null if the user has not specified a public email address in their profile).'
type: string
followers:
type: integer
following:
type: integer
gravatar_id:
type: string
hireable:
type: boolean
html_url:
type: string
id:
type: integer
location:
type: string
login:
type: string
name:
type: string
public_gists:
type: integer
public_repos:
type: integer
type:
type: string
url:
type: string
type: object
user-userId-starred:
items: {}
type: array
user-userId-subscribitions:
items:
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: integer
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: array
users:
items:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
users-userId-keys:
items: {}
type: array
users-userId-orgs:
items: {}
type: array
examples/html/digitaloceancl.html view on Meta::CPAN
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body>
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#ABSTRACT">ABSTRACT</a></li>
examples/html/githubcl.html view on Meta::CPAN
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body>
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#ABSTRACT">ABSTRACT</a></li>
examples/html/githubcl.html view on Meta::CPAN
username * Name of the user. </code></pre>
<h3 id="GET-orgs-:org-repos">GET /orgs/:org/repos</h3>
<pre><code> githubcl GET /orgs/:org/repos [options] <org></code></pre>
<p>List repositories for the specified org....</p>
<p>Options:</p>
<pre><code> --q-type </code></pre>
<p>Parameters:</p>
<pre><code> org * Name of organisation.</code></pre>
<h3 id="GET-orgs-:org-teams">GET /orgs/:org/teams</h3>
<pre><code> githubcl GET /orgs/:org/teams <org></code></pre>
<p>List teams.</p>
examples/html/githubcl.html view on Meta::CPAN
<p>List public and private organizations for the auth...</p>
<h3 id="GET-user-repos">GET /user/repos</h3>
<pre><code> githubcl GET /user/repos [options]</code></pre>
<p>List repositories for the authenticated user. Note...</p>
<p>Options:</p>
<pre><code> --q-type </code></pre>
<h3 id="GET-user-starred">GET /user/starred</h3>
<pre><code> githubcl GET /user/starred [options]</code></pre>
<p>List repositories being starred by the authenticat...</p>
<p>Options:</p>
<pre><code> --q-direction Ignored without 'sort' parameter.
examples/html/githubcl.html view on Meta::CPAN
<pre><code> username * Name of user.</code></pre>
<h3 id="GET-users-:username-repos">GET /users/:username/repos</h3>
<pre><code> githubcl GET /users/:username/repos [options] <username></code></pre>
<p>List public repositories for the specified user....</p>
<p>Options:</p>
<pre><code> --q-type </code></pre>
<p>Parameters:</p>
<pre><code> username * Name of user.</code></pre>
<h3 id="GET-users-:username-starred">GET /users/:username/starred</h3>
<pre><code> githubcl GET /users/:username/starred <username></code></pre>
<p>List repositories being starred by a user....</p>
examples/html/metacpancl.html view on Meta::CPAN
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body>
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#ABSTRACT">ABSTRACT</a></li>
examples/html/metacpancl.html view on Meta::CPAN
<pre><code> module * Module name</code></pre>
<h3 id="GET-pod-:module">GET /pod/:module</h3>
<pre><code> metacpancl GET /pod/:module [options] <module></code></pre>
<p>Module POD</p>
<p>Options:</p>
<pre><code> --q-content-type Default is text/html</code></pre>
<p>Parameters:</p>
<pre><code> module * Module name</code></pre>
<h3 id="GET-release-:author-:release">GET /release/:author/:release</h3>
<pre><code> metacpancl GET /release/:author/:release <author> <release></code></pre>
<p>Release information</p>
examples/metacpancl-appspec.yaml view on Meta::CPAN
version: 3
paths:
/author/:author:
get:
description: Author information
parameters:
- description: CPAN handle
in: path
name: author
required: true
type: string
/distribution/:distribution:
get:
description: Distribution information not specific to a version
parameters:
- description: distribution name
in: path
name: distribution
required: true
type: string
/file:
post:
description: file
parameters:
- description: query
in: body
name: body
required: true
type: object
/module/:module:
get:
description: Module information
parameters:
- description: Module name
in: path
name: module
required: true
type: string
/pod/:module:
get:
description: Module POD
parameters:
- description: Module name
in: path
name: module
required: true
type: string
- description: Default is text/html
enum: &1
- text/html
- text/plain
- text/x-pod
- text/x-markdown
in: query
name: content-type
type: string
/release/:author/:release:
get:
description: Release information
parameters:
- description: CPAN handle
in: path
name: author
required: true
type: string
- description: release, e.g. Moose-123
in: path
name: release
required: true
type: string
/release/:distribution:
get:
description: Release information
parameters:
- description: distribution name
in: path
name: distribution
required: true
type: string
/release/_search:
get:
description: Search releases
parameters:
- description: query ("author:ANDK AND status:latest")
in: query
name: q
required: true
type: string
- description: resultset fields
in: query
name: fields
type: string
- description: how many results
in: query
name: size
type: integer
schemes:
- https
swagger: 2.0
options:
- name: data-file
summary: File with data for POST/PUT/PATCH/DELETE requests
type: file
- aliases:
- d
name: debug
summary: debug
type: flag
- aliases:
- v
name: verbose
summary: verbose
type: flag
subcommands:
GET:
op: apicall
subcommands:
/author/:author:
options: []
parameters:
- name: author
required: 1
summary: CPAN handle
type: string
summary: Author information
/distribution/:distribution:
options: []
parameters:
- name: distribution
required: 1
summary: distribution name
type: string
summary: Distribution information not specific to a version...
/module/:module:
options: []
parameters:
- name: module
required: 1
summary: Module name
type: string
summary: Module information
/pod/:module:
options:
- enum: *1
name: q-content-type
required: ~
summary: Default is text/html
type: string
parameters:
- name: module
required: 1
summary: Module name
type: string
summary: Module POD
/release/:author/:release:
options: []
parameters:
- name: author
required: 1
summary: CPAN handle
type: string
- name: release
required: 1
summary: release, e.g. Moose-123
type: string
summary: Release information
/release/:distribution:
options: []
parameters:
- name: distribution
required: 1
summary: distribution name
type: string
summary: Release information
/release/_search:
options:
- name: q-q
required: 1
summary: query ("author:ANDK AND status:latest")
type: string
- name: q-fields
required: ~
summary: resultset fields
type: string
- name: q-size
required: ~
summary: how many results
type: integer
parameters: []
summary: Search releases
summary: GET call
POST:
op: apicall
subcommands:
/file:
options: []
parameters: []
summary: file
examples/metacpancl-openapi.yaml view on Meta::CPAN
basePath: /v0
paths:
/author/:author:
get:
description: Author information
parameters:
-
name: author
in: path
type: string
required: true
description: CPAN handle
/distribution/:distribution:
get:
description: Distribution information not specific to a version
parameters:
-
name: distribution
in: path
type: string
required: true
description: distribution name
/release/:distribution:
get:
description: Release information
parameters:
-
name: distribution
in: path
type: string
required: true
description: distribution name
/release/:author/:release:
get:
description: Release information
parameters:
-
name: author
in: path
type: string
required: true
description: CPAN handle
-
name: release
in: path
type: string
required: true
description: release, e.g. Moose-123
/module/:module:
get:
description: Module information
parameters:
-
name: module
in: path
type: string
required: true
description: Module name
/pod/:module:
get:
description: Module POD
parameters:
-
name: module
in: path
type: string
required: true
description: Module name
-
name: content-type
in: query
type: string
enum: [text/html, text/plain, text/x-pod, text/x-markdown]
description: Default is text/html
/release/_search:
get:
description: Search releases
parameters:
-
name: q
in: query
type: string
required: true
description: query ("author:ANDK AND status:latest")
-
name: fields
in: query
type: string
description: resultset fields
-
name: size
in: query
type: integer
description: how many results
/file:
post:
description: file
parameters:
-
name: body
in: body
type: object
required: true
description: query
# vim:et:sts=2:sws=2:sw=2:foldmethod=indent
examples/pod/githubcl.pod view on Meta::CPAN
username * Name of the user.
=head3 GET /orgs/:org/repos
githubcl GET /orgs/:org/repos [options] <org>
List repositories for the specified org....
Options:
--q-type
Parameters:
org * Name of organisation.
=head3 GET /orgs/:org/teams
githubcl GET /orgs/:org/teams <org>
List teams.
examples/pod/githubcl.pod view on Meta::CPAN
=head3 GET /user/repos
githubcl GET /user/repos [options]
List repositories for the authenticated user. Note...
Options:
--q-type
=head3 GET /user/starred
githubcl GET /user/starred [options]
List repositories being starred by the authenticat...
Options:
examples/pod/githubcl.pod view on Meta::CPAN
username * Name of user.
=head3 GET /users/:username/repos
githubcl GET /users/:username/repos [options] <username>
List public repositories for the specified user....
Options:
--q-type
Parameters:
username * Name of user.
=head3 GET /users/:username/starred
githubcl GET /users/:username/starred <username>
List repositories being starred by a user....
examples/pod/metacpancl.pod view on Meta::CPAN
module * Module name
=head3 GET /pod/:module
metacpancl GET /pod/:module [options] <module>
Module POD
Options:
--q-content-type Default is text/html
Parameters:
module * Module name
=head3 GET /release/:author/:release
metacpancl GET /release/:author/:release <author> <release>
Release information
examples/zsh/_digitaloceancl view on Meta::CPAN
#compdef digitaloceancl
_digitaloceancl() {
local program=digitaloceancl
typeset -A opt_args
local curcontext="$curcontext" state line context
# ---- Command:
_arguments -s \
'1: :->cmd1' \
'*: :->args' \
&& ret=0
examples/zsh/_githubcl view on Meta::CPAN
#compdef githubcl
_githubcl() {
local program=githubcl
typeset -A opt_args
local curcontext="$curcontext" state line context
# ---- Command:
_arguments -s \
'1: :->cmd1' \
'*: :->args' \
&& ret=0
examples/zsh/_githubcl view on Meta::CPAN
'1: :->cmd1' \
'2: :->cmd2' \
'3: :->org' \
'--data-file[File with data for POST/PUT/PATCH/DELETE requests]:data-file:_files' \
'--debug[debug]' \
'-d[debug]' \
'--verbose[verbose]' \
'-v[verbose]' \
'--help[Show command help]' \
'-h[Show command help]' \
'--q-type[]:q-type:("all" "public" "private" "forks" "sources" "member")' \
&& ret=0
case $state in
org)
;;
esac
;;
/orgs/:org/teams)
examples/zsh/_githubcl view on Meta::CPAN
_arguments -s -C \
'1: :->cmd1' \
'2: :->cmd2' \
'--data-file[File with data for POST/PUT/PATCH/DELETE requests]:data-file:_files' \
'--debug[debug]' \
'-d[debug]' \
'--verbose[verbose]' \
'-v[verbose]' \
'--help[Show command help]' \
'-h[Show command help]' \
'--q-type[]:q-type:("all" "public" "private" "forks" "sources" "member")' \
&& ret=0
;;
/user/starred)
# ---- Command: GET /user/starred
_arguments -s -C \
'1: :->cmd1' \
'2: :->cmd2' \
examples/zsh/_githubcl view on Meta::CPAN
'1: :->cmd1' \
'2: :->cmd2' \
'3: :->username' \
'--data-file[File with data for POST/PUT/PATCH/DELETE requests]:data-file:_files' \
'--debug[debug]' \
'-d[debug]' \
'--verbose[verbose]' \
'-v[verbose]' \
'--help[Show command help]' \
'-h[Show command help]' \
'--q-type[]:q-type:("all" "public" "private" "forks" "sources" "member")' \
&& ret=0
case $state in
username)
;;
esac
;;
/users/:username/starred)
examples/zsh/_metacpancl view on Meta::CPAN
#compdef metacpancl
_metacpancl() {
local program=metacpancl
typeset -A opt_args
local curcontext="$curcontext" state line context
# ---- Command:
_arguments -s \
'1: :->cmd1' \
'*: :->args' \
&& ret=0
examples/zsh/_metacpancl view on Meta::CPAN
'1: :->cmd1' \
'2: :->cmd2' \
'3: :->module' \
'--data-file[File with data for POST/PUT/PATCH/DELETE requests]:data-file:_files' \
'--debug[debug]' \
'-d[debug]' \
'--verbose[verbose]' \
'-v[verbose]' \
'--help[Show command help]' \
'-h[Show command help]' \
'--q-content-type[Default is text/html]:q-content-type:("text/html" "text/plain" "text/x-pod" "text/x-markdown")' \
&& ret=0
case $state in
module)
;;
esac
;;
/release/:author/:release)
lib/API/CLI.pm view on Meta::CPAN
# 1. parameter: owner
# 2. parameter: repo
% githubcl GET /repos/:owner/:repo perlpunk API-CLI-p5
The generated help will show all methods, endpoints, parameters and
options.
Query parameters are represented as command line options starting with
C<--q->:
% metacpancl GET /pod/:module App::Spec --q-content-type text/x-pod
=head1 NAME
App::Spec - Specification for commandline apps
...
It can also generate shell tab completion:
% metacpancl <TAB>
GET -- GET call
POST -- POST call
help -- Show command help
% digitaloceancl GET /<TAB>
/account -- Account information
/droplets -- List all droplets
/droplets/:id -- Retrieve a droplet by id
% metacpancl GET /pod/:module App::Spec --q-content-type text/<TAB>
text/html text/plain text/x-markdown text/x-pod
Bash users: Note that completion for options and parameters currently does not
work.
=head1 METHODS
=over 4
lib/API/CLI/App/Spec.pm view on Meta::CPAN
};
}
}
$spec->{openapi} = $openapi;
my $options = $spec->{options} ||= [];
push @$options, {
name => "data-file",
type => "file",
summary => "File with data for POST/PUT/PATCH/DELETE requests",
};
push @$options, {
name => "debug",
type => "flag",
summary => "debug",
aliases => ['d'],
};
push @$options, {
name => "verbose",
type => "flag",
summary => "verbose",
aliases => ['v'],
};
$spec->{apppec}->{version} = '0.001';
return $spec;
}
sub param2appspec {
my ($self, $p) = @_;
my $type = $p->{type};
my $required = $p->{required};
my $item = {
name => $p->{name},
type => $type,
required => $required,
summary => $p->{description},
$p->{enum} ? (enum => $p->{enum}) : (),
};
if ($p->{in} eq 'path') {
}
elsif ($p->{in} eq 'query') {
$item->{name} = "q-" . $item->{name};
}
return $item;
lib/API/CLI/Request.pm view on Meta::CPAN
sub request {
my ($self) = @_;
my $ua = LWP::UserAgent->new;
my $req = $self->req;
my $res = $ua->request($req);
my $code = $res->code;
my $content = $res->decoded_content;
my $status = $res->status_line;
my $ct = $res->content_type;
my $out = $self->verbose ? "Response: $status ($ct)\n" : undef;
my $data;
my $ok = 0;
if ($res->is_success) {
$ok = 1;
if ($ct eq 'application/json') {
my $coder = JSON::XS->new->ascii->pretty->allow_nonref;
$data = $coder->decode($content);
$content = $coder->encode($data);
}
share/apicli-spec.yaml view on Meta::CPAN
summary: Output file (default stdout)
- name: name
summary: appname
required: true
- name: class
summary: Class name (default API::CLI)
parameters:
- name: "file"
summary: "openapi file"
required: true
type: file
# vim:et:sts=2:sws=2:sw=2:foldmethod=indent
share/completion/zsh/_apicli view on Meta::CPAN
#compdef apicli
_apicli() {
local program=apicli
typeset -A opt_args
local curcontext="$curcontext" state line context
# ---- Command:
_arguments -s \
'1: :->cmd1' \
'*: :->args' \
&& ret=0
( run in 2.629 seconds using v1.01-cache-2.11-cpan-df04353d9ac )