API-CLI
view release on metacpan or search on metacpan
examples/githubcl-appspec.yaml view on Meta::CPAN
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
examples/githubcl-appspec.yaml view on Meta::CPAN
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:
examples/githubcl-appspec.yaml view on Meta::CPAN
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:
examples/githubcl-appspec.yaml view on Meta::CPAN
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:
examples/githubcl-appspec.yaml view on Meta::CPAN
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:
examples/githubcl-appspec.yaml view on Meta::CPAN
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:
examples/githubcl-appspec.yaml view on Meta::CPAN
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
examples/githubcl-appspec.yaml view on Meta::CPAN
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
examples/githubcl-appspec.yaml view on Meta::CPAN
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
examples/githubcl-appspec.yaml view on Meta::CPAN
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
examples/githubcl-appspec.yaml view on Meta::CPAN
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/emojis'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/events:
get:
description: List public events.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/events'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/feeds:
get:
description: |
List Feeds.
GitHub provides several timeline resources in Atom format. The Feeds API
lists all the feeds available to the authenticating user.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/feeds'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/gists:
get:
description: |
List the authenticated user's gists or if called anonymously, this will
return all public gists.
parameters:
- description: |
Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.
Only gists updated at or after this time are returned.
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gists'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a gist.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/postGist'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/gist'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/gists/public:
get:
description: List all public gists.
parameters:
- description: |
Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.
Only gists updated at or after this time are returned.
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gists'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/gists/starred:
get:
description: List the authenticated user's starred gists.
parameters:
- description: |
Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.
Only gists updated at or after this time are returned.
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gists'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/gists/{id}:
delete:
description: Delete a gist.
parameters:
- description: Id of gist.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
examples/githubcl-appspec.yaml view on Meta::CPAN
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gitignore'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/gitignore/templates/{language}:
get:
description: Get a single template.
parameters:
- in: path
name: language
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gitignore-lang'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/issues:
get:
description: |
List issues.
List all issues across all the authenticated user's visible repositories.
parameters:
- default: all
description: |
Issues assigned to you / created by you / mentioning you / you're
subscribed to updates for / All issues the authenticated user can see
enum: &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
examples/githubcl-appspec.yaml view on Meta::CPAN
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/patchOrg'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/organization'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/orgs/{org}/events:
get:
description: List public events for an organization.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/events'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/orgs/{org}/issues:
get:
description: |
List issues.
List all issues for a given organization for the authenticated user.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- default: all
description: |
Issues assigned to you / created by you / mentioning you / you're
subscribed to updates for / All issues the authenticated user can see
enum: &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:
get:
description: |
Members list.
List all users who are members of an organization. A member is a user tha
belongs to at least 1 team in the organization. If the authenticated user
is also an owner of this organization then both concealed and public members
will be returned. If the requester is not an owner of the organization the
query will be redirected to the public members list.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'302':
description: Response if requester is not an organization member.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/orgs/{org}/members/{username}:
delete:
description: |
Remove a member.
Removing a user from this list will remove them from all teams and they
will no longer have any access to the organization's repositories.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: Name of the user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/orgs/{org}/teams:
get:
description: List teams.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/teams'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create team.
In order to create a team, the authenticated user must be an owner of organization.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/orgTeamsPost'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/team'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/rate_limit:
get:
description: |
Get your current rate limit status
Note: Accessing this endpoint does not count against your rate limit.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
examples/githubcl-appspec.yaml view on Meta::CPAN
description: OK
schema:
$ref: '#/definitions/branches'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/branches/{branch}:
get:
description: Get Branch
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Name of the branch.
in: path
name: branch
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/branch'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/collaborators:
get:
description: |
List.
When authenticating as an organization owner of an organization-owned
repository, all organization owners are included in the list of
collaborators. Otherwise, only users with access to the repository are
returned in the collaborators list.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/collaborators/{user}:
delete:
description: Remove collaborator.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Login of the user.
in: path
examples/githubcl-appspec.yaml view on Meta::CPAN
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/commentBody'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/commitComments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/commits:
get:
description: List commits on a repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
in: query
name: since
type: string
- description: Sha or branch to start listing commits from.
in: query
name: sha
type: string
- description: Only commits containing this file path will be returned.
in: query
name: path
type: string
- description: GitHub login, name, or email by which to filter by commit author.
in: query
name: author
type: string
- description: ISO 8601 Date - Only commits before this date will be returned.
in: query
name: until
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/commits'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/commits/{ref}/status:
get:
description: |
Get the combined Status for a specific Ref
The Combined status endpoint is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details.
To access this endpoint during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.she-hulk-preview+json
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: ref
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
examples/githubcl-appspec.yaml view on Meta::CPAN
- description: Name 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
examples/githubcl-appspec.yaml view on Meta::CPAN
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'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/teams/{teamId}/members:
get:
description: |
List team members.
In order to list members in a team, the authenticated user must be a member
of the team.
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/teams/{teamId}/members/{username}:
delete:
description: |
The "Remove team member" API is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Remove team membership API instead. It allows you to remove both active and pending memberships.
Remove team member.
In order to remove a user from a team, the authenticated user must have 'admin'
permissions to the team or be an owner of the org that the team is associated
with.
NOTE This does not delete the user, it just remove them from the team.
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: Name of a member.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Team member removed.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: |
The "Get team member" API is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Get team membership API instead. It allows you to get both active and pending memberships.
Get team member.
In order to get if a user is a member of a team, the authenticated user mus
be a member of the team.
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: Name of a member.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: User is a member.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: User is not a member.
put:
description: |
The API (described below) is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Add team membership API instead. It allows you to invite new organization members to your teams.
Add team member.
In order to add a user to a team, the authenticated user must have 'admin'
permissions to the team or be an owner of the org that the team is associated
with.
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: Name of a member.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Team member added.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'422':
description: If you attempt to add an organization to a team, you will
get this.
schema:
$ref: '#/definitions/organizationAsTeamMember'
/teams/{teamId}/memberships/{username}:
delete:
description: |
Remove team membership.
In order to remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. NOTE: This does not delete the user, it just 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':
description: User has no membership with team
put:
description: |
Add team membership.
In order to add a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with.
If the user is already a part of the team's organization (meaning they're on at least one other team in the organization), this endpoint will add the user to the team.
If the user is completely unaffiliated with the team's organization (meaning they're on none of the organization's teams), this endpoint will send an invitation to the user via email. This newly-created membership will be in the 'pending' 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':
description: If you attempt to add an organization to a team, you will
get this.
schema:
$ref: '#/definitions/organizationAsTeamMember'
/teams/{teamId}/repos:
get:
description: List team repos
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/teamRepos'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/teams/{teamId}/repos/{org}/{repo}:
put:
description: In order to add a repository to a team, the authenticated user
must be an owner of the org that the team is associated with. Also, the
repository must be owned by the organization, or a direct fork of a repository
owned by the 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'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/emails:
delete:
description: |
Delete email address(es).
You can include a single email address or an array of addresses.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
examples/githubcl-appspec.yaml view on Meta::CPAN
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
produces:
- application/vnd.github.v3
responses:
'200':
description: OK
schema:
$ref: '#/definitions/user-emails'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Add email address(es).
You can post a single email address or an array of addresses.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/emailsPost'
responses:
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/followers:
get:
description: List the authenticated user's followers
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/following:
get:
description: List who the authenticated user is following.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/following/{username}:
delete:
description: |
Unfollow a user.
Unfollowing a user requires the user to be logged in and authenticated with
basic auth or OAuth with the user:follow scope.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: User unfollowed.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Check if you are following a user.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Response if you are following this user.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: Response if you are not following this user.
put:
description: |
Follow a user.
Following a user requires the user to be logged in and authenticated with
basic auth or OAuth with the user:follow scope.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: You are now following the user.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/issues:
get:
description: |
List issues.
List all issues across owned and member repositories for the authenticated
user.
parameters:
- default: all
description: |
Issues assigned to you / created by you / mentioning you / you're
subscribed to updates for / All issues the authenticated user can see
enum: &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'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/keys/{keyId}:
delete:
description: Delete a public key. Removes a public key. Requires that you
are authenticated via Basic Auth or via OAuth with at least admin:public_key
scope.
parameters:
- description: ID of key.
in: path
name: keyId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: "No content.\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:
get:
description: |
List repositories for the authenticated user. Note that this does not include
repositories owned by organizations which the user can access. You can lis
user organizations and list organization repositories separately.
parameters:
- default: all
enum: &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'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/starred:
get:
description: List repositories being starred by the authenticated user.
parameters:
- description: Ignored without 'sort' parameter.
in: query
name: direction
type: string
- default: created
description: ''
enum: &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
examples/githubcl-appspec.yaml view on Meta::CPAN
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
examples/githubcl-appspec.yaml view on Meta::CPAN
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
examples/githubcl-appspec.yaml view on Meta::CPAN
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
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: ''
read:org: ''
read:public_key: ''
read:repo_hook: ''
repo: ''
repo:status: ''
repo_deployment: ''
user: ''
user:email: ''
user:follow: ''
write:org: ''
write:public_key: ''
write:repo_hook: ''
tokenUrl: https://github.com/login/oauth/access_token
type: oauth2
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
examples/githubcl-appspec.yaml view on Meta::CPAN
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:
options: []
parameters: []
summary: List public events.
/feeds:
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: ~
examples/githubcl-appspec.yaml view on Meta::CPAN
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.
examples/githubcl-appspec.yaml view on Meta::CPAN
/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
examples/githubcl-appspec.yaml view on Meta::CPAN
- 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
examples/githubcl-appspec.yaml view on Meta::CPAN
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:
options: []
parameters: []
summary: List the authenticated user's followers...
/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.
examples/githubcl-appspec.yaml view on Meta::CPAN
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
examples/githubcl-appspec.yaml view on Meta::CPAN
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:
options: []
parameters: []
summary: Create a new repository for the authenticated user...
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
examples/githubcl-appspec.yaml view on Meta::CPAN
- 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
( run in 1.145 second using v1.01-cache-2.11-cpan-5c0b1e786e0 )