API-CLI
view release on metacpan or search on metacpan
examples/githubcl-appspec.yaml view on Meta::CPAN
---
apppec:
version: '0.001'
class: API::CLI
name: githubcl
openapi:
basePath: /
consumes:
- application/json
definitions:
asset:
properties:
content_type:
type: string
created_at:
type: string
download_count:
type: number
id:
type: number
label:
type: string
name:
type: string
size:
type: number
state:
type: string
updated_at:
type: string
uploader:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: number
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
url:
type: string
type: object
assetPatch:
properties:
label:
type: string
name:
type: string
required:
- name
type: object
assets:
items:
properties:
content_type:
type: string
created_at:
type: string
download_count:
type: number
id:
type: number
label:
type: string
name:
type: string
size:
type: number
state:
type: string
updated_at:
type: string
uploader:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: number
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
url:
type: string
type: object
type: array
assignees:
items:
properties:
avatar_url:
type: integer
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
blob:
properties:
content:
type: string
encoding:
enum:
- utf-8
- base64
sha:
type: string
size:
type: integer
type: object
blobs:
properties:
sha:
type: string
type: object
branch:
properties:
_links:
properties:
html:
type: string
self:
type: string
type: object
commit:
properties:
author:
properties:
avatar_url:
type: string
gravatar_id:
type: string
examples/githubcl-appspec.yaml view on Meta::CPAN
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
url:
type: string
type: object
type: array
compare-commits:
properties:
ahead_by:
type: integer
base_commit:
properties:
author:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
commit:
properties:
author:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
committer:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
committer:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
url:
type: string
type: object
behind_by:
type: integer
commits:
items:
properties:
author:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
commit:
properties:
author:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
committer:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
committer:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
url:
type: string
type: object
type: array
diff_url:
type: string
files:
items:
properties:
additions:
type: integer
blob_url:
type: string
changes:
type: integer
contents_url:
type: string
deletions:
type: integer
filename:
type: string
patch:
type: string
raw_url:
type: string
sha:
type: string
status:
type: string
type: object
type: array
html_url:
type: string
patch_url:
type: string
permalink_url:
type: string
status:
type: string
total_commits:
type: integer
url:
type: string
examples/githubcl-appspec.yaml view on Meta::CPAN
email:
type: string
name:
type: string
type: object
message:
type: string
sha:
type: string
type: object
deployment:
properties:
description:
type: string
payload:
properties:
deploy_user:
type: string
environment:
type: string
room_id:
type: number
type: object
ref:
type: string
type: object
deployment-resp:
properties:
created_at:
type: string
creator:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
description:
type: string
id:
type: integer
payload:
type: string
sha:
type: string
statuses_url:
type: string
updated_at:
type: string
url:
type: string
type: object
deployment-statuses:
items:
properties:
created_at:
type: string
creator:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
description:
type: string
id:
type: integer
payload:
type: string
state:
type: string
target_url:
type: string
updated_at:
type: string
url:
type: string
type: object
type: array
deployment-statuses-create:
properties:
description:
type: string
state:
type: string
target_url:
type: string
type: object
downloadBody:
properties:
content_type:
type: string
description:
type: string
name:
type: string
size:
description: Size of file in bytes.
type: integer
required:
- name
- size
type: object
downloads:
properties:
content_type:
type: string
description:
type: string
download_count:
type: integer
html_url:
type: string
id:
type: integer
name:
type: string
examples/githubcl-appspec.yaml view on Meta::CPAN
type: array
merge:
properties:
merged:
type: boolean
message:
type: string
sha:
type: string
type: object
mergePullBody:
properties:
commit_message:
type: string
type: object
mergesBody:
properties:
base:
type: string
commit_message:
type: string
head:
type: string
type: object
mergesConflict:
properties:
message:
description: Error message
type: string
type: object
mergesSuccessful:
properties:
author:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
comments_url:
type: string
commit:
properties:
author:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
comment_count:
type: integer
committer:
properties:
date:
type: string
email:
type: string
name:
type: string
type: object
message:
type: string
tree:
properties:
sha:
type: string
url:
type: string
type: object
url:
type: string
type: object
committer:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
merged:
type: boolean
message:
type: string
parents:
items:
properties:
sha:
type: string
url:
type: string
type: object
type: array
sha:
type: string
url:
type: string
type: object
meta:
properties:
git:
items:
description: An Array of IP addresses in CIDR format specifying the Git
servers at GitHub.
type: string
type: array
hooks:
items:
description: An Array of IP addresses in CIDR format specifying the addresses
that incoming service hooks will originate from.
type: string
type: array
type: object
milestone:
properties:
closed_issues:
type: integer
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
creator:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
description:
examples/githubcl-appspec.yaml view on Meta::CPAN
type: string
title:
type: string
type: object
milestoneUpdate:
properties:
description:
type: string
due_on:
type: string
state:
type: string
title:
type: string
type: object
notificationMarkRead:
properties:
last_read_at:
type: string
type: object
notifications:
properties:
id:
type: integer
last_read_at:
type: string
reason:
type: string
repository:
properties:
description:
type: string
fork:
type: boolean
full_name:
type: string
html_url:
type: string
id:
type: integer
name:
type: string
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
url:
type: string
type: object
subject:
properties:
latest_comment_url:
type: string
title:
type: string
type:
type: string
url:
type: string
type: object
unread:
type: boolean
updated_at:
type: string
url:
type: string
type: object
orgMembers:
items:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
orgPublicMembers:
items:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
orgTeams:
items:
properties:
id:
type: integer
name:
type: string
url:
type: string
type: object
type: array
orgTeamsPost:
properties:
examples/githubcl-appspec.yaml view on Meta::CPAN
href:
type: string
type: object
type: object
body:
type: string
commit_id:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
id:
type: integer
path:
type: string
position:
type: integer
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
user:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: object
type: array
pullsPost:
properties:
base:
type: string
body:
type: string
head:
type: string
title:
type: string
type: object
punchCardStats:
items:
type: integer
type: array
putSubscription:
properties:
created_at:
type: string
ignored:
type: boolean
reason:
type: object
subscribed:
type: boolean
thread_url:
type: string
url:
type: string
type: object
rate_limit:
properties:
rate:
properties:
limit:
type: integer
remaining:
type: integer
reset:
type: integer
type: object
readme:
properties:
_links:
properties:
git:
type: string
html:
type: string
self:
type: string
type: object
content:
type: string
encoding:
type: string
git_url:
type: string
html_url:
type: string
name:
type: string
path:
type: string
sha:
type: string
size:
type: integer
type:
type: string
url:
type: string
type: object
ref:
items:
properties:
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
creator:
properties:
avatar_url:
type: string
gravatar_id:
examples/githubcl-appspec.yaml view on Meta::CPAN
refsBody:
properties:
ref:
type: string
sha:
type: string
type: object
release:
properties:
assets:
items:
properties:
content_type:
type: string
created_at:
type: string
download_count:
type: integer
id:
type: integer
label:
type: string
name:
type: string
size:
type: integer
state:
type: string
updated_at:
type: string
uploader:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
url:
type: string
type: object
type: array
assets_url:
type: string
author:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
body:
type: string
created_at:
type: string
draft:
type: boolean
html_url:
type: string
id:
type: integer
name:
type: string
prerelease:
type: boolean
published_at:
type: string
tag_name:
type: string
tarball_url:
type: string
target_commitish:
type: string
upload_url:
type: string
url:
type: string
zipball_url:
type: string
type: object
release-create:
properties:
body:
type: string
draft:
type: boolean
name:
type: string
prerelease:
type: boolean
tag_name:
type: string
target_commitish:
type: string
type: object
releases:
items:
properties:
assets:
items:
properties:
content_type:
type: string
created_at:
type: string
download_count:
type: integer
id:
type: integer
label:
type: string
name:
type: string
size:
type: integer
state:
type: string
updated_at:
type: string
uploader:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
url:
type: string
type: object
type: array
assets_url:
type: string
author:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
body:
type: string
created_at:
type: string
draft:
type: boolean
html_url:
type: string
id:
type: integer
name:
type: string
prerelease:
type: boolean
published_at:
type: string
tag_name:
type: string
tarball_url:
type: string
target_commitish:
type: string
upload_url:
type: string
url:
type: string
zipball_url:
type: string
type: object
type: array
repo:
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
has_downloads:
type: boolean
has_issues:
type: boolean
has_wiki:
examples/githubcl-appspec.yaml view on Meta::CPAN
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
ssh_url:
type: string
svn_url:
type: string
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
watchers:
type: integer
watchers_count:
type: integer
type: object
repo-deployments:
items:
properties:
created_at:
type: string
creator:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
description:
type: string
id:
type: integer
payload:
type: string
sha:
type: string
statuses_url:
type: string
updated_at:
type: string
url:
type: string
type: object
type: array
repoComments:
items:
properties:
body:
type: string
commit_id:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
html_url:
type: string
id:
type: integer
line:
type: integer
path:
type: string
position:
type: integer
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
user:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
examples/githubcl-appspec.yaml view on Meta::CPAN
git_commits_url:
type: string
git_refs_url:
type: string
git_tags_url:
type: string
hooks_url:
type: string
html_url:
type: string
id:
type: integer
issue_comment_url:
type: string
issue_events_url:
type: string
issues_url:
type: string
keys_url:
type: string
labels_url:
type: string
languages_url:
type: string
merges_url:
type: string
milestones_url:
type: string
name:
type: string
notifications_url:
type: string
owner:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
private:
type: boolean
pulls_url:
type: string
stargazers_url:
type: string
statuses_url:
type: string
subscribers_url:
type: string
subscription_url:
type: string
tags_url:
type: string
teams_url:
type: string
trees_url:
type: string
url:
type: string
type: object
score:
type: number
sha:
type: string
url:
type: string
type: object
type: array
total_count:
type: integer
type: object
search-issues:
properties:
items:
items:
properties:
assignee:
type: 'null'
body:
type: string
closed_at:
type: 'null'
comments:
type: integer
comments_url:
type: string
created_at:
type: string
events_url:
type: string
html_url:
type: string
id:
type: integer
labels:
items:
properties:
color:
type: string
name:
type: string
url:
type: string
type: object
type: array
labels_url:
type: string
milestone:
type: 'null'
number:
type: integer
pull_request:
properties:
diff_url:
type: 'null'
html_url:
type: 'null'
patch_url:
type: 'null'
type: object
score:
type: number
state:
type: string
title:
type: string
updated_at:
type: string
url:
type: string
user:
properties:
avatar_url:
type: string
events_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
starred_url:
type: string
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
type: object
type: array
total_count:
type: integer
type: object
search-issues-by-keyword:
properties:
issues:
items:
properties:
body:
type: string
comments:
type: integer
created_at:
type: string
gravatar_id:
type: string
html_url:
type: string
labels:
items:
type: string
type: array
number:
type: integer
position:
type: integer
state:
type: string
title:
type: string
updated_at:
type: string
user:
type: string
votes:
type: integer
type: object
type: array
type: object
search-repositories:
properties:
items:
items:
properties:
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
default_branch:
type: string
description:
type: string
fork:
examples/githubcl-appspec.yaml view on Meta::CPAN
properties:
user:
properties:
blog:
type: string
company:
type: string
created:
type: string
created_at:
type: string
email:
type: string
followers_count:
type: integer
following_count:
type: integer
gravatar_id:
type: string
id:
type: integer
location:
type: string
login:
type: string
name:
type: string
public_gist_count:
type: integer
public_repo_count:
type: integer
type:
type: string
type: object
type: object
search-users:
properties:
items:
items:
properties:
avatar_url:
type: string
followers_url:
type: string
gravatar_id:
type: string
html_url:
type: string
id:
type: integer
login:
type: string
organizations_url:
type: string
received_events_url:
type: string
repos_url:
type: string
score:
type: number
subscriptions_url:
type: string
type:
type: string
url:
type: string
type: object
type: array
total_count:
type: integer
type: object
search-users-by-keyword:
properties:
users:
items:
properties:
created:
type: string
created_at:
type: string
followers:
type: integer
followers_count:
type: integer
fullname:
type: string
gravatar_id:
type: string
id:
type: string
language:
type: string
location:
type: string
login:
type: string
name:
type: string
public_repo_count:
type: integer
repos:
type: integer
score:
type: number
type:
type: string
username:
type: string
type: object
type: array
type: object
stargazers:
items:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
subscribition:
properties:
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
ignored:
type: boolean
reason:
type: string
repository_url:
type: string
subscribed:
type: boolean
url:
type: string
type: object
subscribitionBody:
properties:
ignored:
type: boolean
subscribed:
type: boolean
type: object
subscription:
properties:
created_at:
type: string
ignored:
type: boolean
reason:
type: boolean
subscribed:
type: boolean
thread_url:
type: string
url:
type: string
type: object
tag:
properties:
message:
type: string
object:
properties:
sha:
type: string
type:
type: string
url:
type: string
type: object
sha:
type: string
tag:
type: string
tagger:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
url:
type: string
type: object
tags:
properties:
message:
description: String of the tag message.
type: string
object:
description: String of the SHA of the git object this is tagging.
type: string
tag:
type: string
tagger:
properties:
date:
description: Timestamp of when this object was tagged.
type: string
email:
description: String of the email of the author of the tag.
type: string
name:
description: String of the name of the author of the tag.
type: string
type: object
type:
description: String of the type of the object we’re tagging. Normally this
examples/githubcl-appspec.yaml view on Meta::CPAN
type: integer
members_count:
type: integer
name:
type: string
organization:
properties:
avatar_url:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
permission:
type: string
repos_count:
type: integer
url:
type: string
type: object
type: array
tree:
properties:
sha:
type: string
tree:
items:
properties:
mode:
type: string
path:
type: string
sha:
type: string
size:
type: integer
type:
type: string
url:
type: string
type: object
type: array
url:
type: string
type: object
trees:
properties:
base_tree:
type: string
sha:
description: SHA1 checksum ID of the object in the tree.
type: string
tree:
items:
properties:
mode:
description: One of 100644 for file (blob), 100755 for executable
(blob), 040000 for subdirectory (tree), 160000 for submodule (commit)
or 120000 for a blob that specifies the path of a symlink.
enum:
- '100644'
- '100755'
- '040000'
- '160000'
- '120000'
type: string
path:
type: string
sha:
description: SHA1 checksum ID of the object in the tree.
type: string
type:
enum:
- blob
- tree
- commit
type: string
url:
type: string
type: object
type: array
url:
type: string
type: object
user:
properties:
avatar_url:
type: string
bio:
type: string
blog:
type: string
collaborators:
type: integer
company:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
disk_usage:
type: integer
email:
type: string
followers:
type: integer
following:
type: integer
gravatar_id:
type: string
hireable:
type: boolean
html_url:
type: string
id:
type: integer
location:
type: string
login:
examples/githubcl-appspec.yaml view on Meta::CPAN
type: string
company:
type: string
email:
type: string
hireable:
type: boolean
location:
type: string
name:
type: string
type: object
user-userId:
properties:
avatar_url:
type: string
bio:
type: string
blog:
type: string
company:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
description: 'Note: The returned email is the user’s publicly visible email
address (or null if the user has not specified a public email address
in their profile).'
type: string
followers:
type: integer
following:
type: integer
gravatar_id:
type: string
hireable:
type: boolean
html_url:
type: string
id:
type: integer
location:
type: string
login:
type: string
name:
type: string
public_gists:
type: integer
public_repos:
type: integer
type:
type: string
url:
type: string
type: object
user-userId-starred:
items: {}
type: array
user-userId-subscribitions:
items:
properties:
clone_url:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
description:
type: string
fork:
type: boolean
forks:
type: integer
forks_count:
type: integer
full_name:
type: string
git_url:
type: string
homepage:
type: string
html_url:
type: string
id:
type: integer
language:
type: string
master_branch:
type: integer
mirror_url:
type: string
name:
type: string
open_issues:
type: integer
open_issues_count:
type: integer
owner:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
private:
type: boolean
pushed_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
size:
type: integer
ssh_url:
type: string
svn_url:
examples/githubcl-appspec.yaml view on Meta::CPAN
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
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
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:
'200':
description: OK
schema:
$ref: '#/definitions/notifications'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Mark a thread as read
parameters:
- description: Id of thread.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'205':
description: Thread marked as read.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/notifications/threads/{id}/subscription:
delete:
description: Delete a Thread Subscription.
parameters:
- description: Id of thread.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: "No Content\n"
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get a Thread Subscription.
parameters:
- description: Id of thread.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/subscription'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
put:
description: |
Set a Thread Subscription.
This lets you subscribe to a thread, or ignore it. Subscribing to a thread
is unnecessary if the user is already subscribed to the repository. Ignoring
a thread will mute all future notifications (until you comment or get @mentioned).
parameters:
- description: Id of thread.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/putSubscription'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/subscription'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/orgs/{org}:
get:
description: Get an Organization.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/organization'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Edit an Organization.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
examples/githubcl-appspec.yaml view on Meta::CPAN
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
examples/githubcl-appspec.yaml view on Meta::CPAN
/repos/{owner}/{repo}/contents/{path}:
delete:
description: |
Delete a file.
This method deletes a file in a repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: path
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/deleteFileBody'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/deleteFile'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: |
Get contents.
This method returns the contents of a file or directory in a repository.
Files and symlinks support a custom media type for getting the raw content.
Directories and submodules do not support custom media types.
Note: This API supports files up to 1 megabyte in size.
Here can be many outcomes. For details see "http://developer.github.com/v3/repos/contents/"
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- in: path
name: path
required: true
type: string
- description: The content path.
in: query
name: path
type: string
- description: The String name of the Commit/Branch/Tag. Defaults to 'master'.
in: query
name: ref
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/contents-path'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
put:
description: Create a file.
parameters:
- description: Name of repository owner.
in: path
examples/githubcl-appspec.yaml view on Meta::CPAN
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Edit a hook.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of hook.
in: path
name: hookId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/hookBody'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/hook'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/hooks/{hookId}/tests:
post:
description: |
Test a push hook.
This will trigger the hook with the latest push to the current repository
if the hook is subscribed to push events. If the hook is not subscribed
to push events, the server will respond with 204 but no test POST will
be generated.
Note: Previously /repos/:owner/:repo/hooks/:id/tes
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of hook.
in: path
name: hookId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Hook is triggered.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/issues:
get:
description: List issues for a repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- default: all
description: |
Issues assigned to you / created by you / mentioning you / you're
subscribed to updates for / All issues the authenticated user can see
enum: &16
- assigned
- created
- mentioned
- subscribed
- all
in: query
name: filter
required: true
type: string
- default: open
enum: &17
- open
- closed
in: query
name: state
required: true
type: string
- description: String list of comma separated Label names. Example - bug,ui,@high.
in: query
name: labels
required: true
type: string
- default: created
enum: &18
- created
- updated
- comments
in: query
name: sort
required: true
type: string
- default: desc
enum: &19
- asc
- desc
in: query
name: direction
required: true
type: string
- description: |
Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only issues updated at or after this time are returned.
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
examples/githubcl-appspec.yaml view on Meta::CPAN
schema:
$ref: '#/definitions/ref'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a Status.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.
in: path
name: ref
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/headBranch'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/ref'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/subscribers:
get:
description: List watchers.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/subscription:
delete:
description: Delete a Repository Subscription.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: "No content.\n"
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get a Repository Subscription.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/subscribition'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
put:
description: Set a Repository Subscription
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/subscribitionBody'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/subscribition'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/tags:
get:
description: Get list of tags.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/tags'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/teams:
get:
description: Get list of teams
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
examples/githubcl-appspec.yaml view on Meta::CPAN
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
examples/githubcl-appspec.yaml view on Meta::CPAN
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: This repository is starred by you.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: This repository is not starred by you.
put:
description: Star a repository.
parameters:
- description: Name of a repository owner.
in: path
name: owner
required: true
type: string
- description: Name of a repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Repository starred.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/subscriptions:
get:
description: List repositories being watched by the authenticated user.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/user-userId-subscribitions'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/subscriptions/{owner}/{repo}:
delete:
description: Stop watching a repository
parameters:
- description: Name of the owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Unwatched.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Check if you are watching a repository.
parameters:
- description: Name of the owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
examples/githubcl-appspec.yaml view on Meta::CPAN
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repos'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/users/{username}/starred:
get:
description: List repositories being starred by a user.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/users/{username}/subscriptions:
get:
description: List repositories being watched by a user.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
produces:
- application/json
schemes:
- https
securityDefinitions:
oauth_2_0:
authorizationUrl: https://github.com/login/oauth/authorize
description: |
OAuth2 is a protocol that lets external apps request authorization to private
details in a user's GitHub account without getting their password. This is
preferred over Basic Authentication because tokens can be limited to specific
types of data, and can be revoked by users at any time.
flow: accessCode
scopes:
admin:org: ''
admin:org_hook: ''
admin:public_key: ''
admin:repo_hook: ''
delete_repo: ''
gist: ''
notifications: ''
public_repo: ''
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
required: 1
summary: Name of organisation.
type: string
- name: username
required: 1
summary: Name of the user.
type: string
summary: Remove a member.
/orgs/:org/public_members/:username:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
- name: username
required: 1
summary: Name of the user.
type: string
summary: Conceal a user's membership.
/repos/:owner/:repo:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Delete a Repository.
/repos/:owner/:repo/collaborators/:user:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: user
required: 1
summary: Login of the user.
type: string
summary: Remove collaborator.
/repos/:owner/:repo/comments/:commentId:
examples/githubcl-appspec.yaml view on Meta::CPAN
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Number of milestone.
type: integer
summary: Delete a milestone.
/repos/:owner/:repo/pulls/comments/:commentId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: commentId
required: 1
summary: Id of comment.
type: integer
summary: Delete a comment.
/repos/:owner/:repo/releases/:id:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: id
required: 1
summary: ~
type: string
summary: Users with push access to the repository can delet...
/repos/:owner/:repo/releases/assets/:id:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: id
required: 1
summary: ~
type: string
summary: Delete a release asset
/repos/:owner/:repo/subscription:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Delete a Repository Subscription....
/teams/:teamId:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
summary: Delete team.
/teams/:teamId/members/:username:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
- name: username
required: 1
summary: Name of a member.
type: string
summary: The "Remove team member" API is deprecated and is ...
/teams/:teamId/memberships/:username:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
- name: username
required: 1
summary: Name of a member.
type: string
summary: Remove team membership.
/teams/:teamId/repos/:owner/:repo:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
- name: owner
required: 1
summary: Name of a repository owner.
type: string
- name: repo
required: 1
summary: Name of a repository.
type: string
summary: In order to remove a repository from a team, the a...
/user/emails:
options: []
parameters: []
summary: Delete email address(es).
/user/following/:username:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: Unfollow a user.
/user/keys/:keyId:
options: []
parameters:
- name: keyId
required: 1
summary: ID of key.
type: integer
summary: Delete a public key. Removes a public key. Require...
/user/starred/:owner/:repo:
options: []
parameters:
- name: owner
required: 1
summary: Name of a repository owner.
type: string
- name: repo
required: 1
summary: Name of a repository.
type: string
summary: Unstar a repository
/user/subscriptions/:owner/:repo:
options: []
parameters:
- name: owner
required: 1
summary: Name of the owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Stop watching a repository
summary: DELETE call
GET:
op: apicall
subcommands:
/emojis:
options: []
parameters: []
summary: Lists all the emojis available to use on GitHub....
/events:
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
- name: q-start_page
required: ~
summary: The page number to fetch
type: string
- enum: *9
name: q-sort
required: ~
summary: 'The sort field. One of stars, forks, or updated. Default: results
are sorted by best match.'
type: string
parameters:
- name: keyword
required: 1
summary: The search term
type: string
summary: Find users by keyword.
/meta:
options: []
parameters: []
summary: This gives some information about GitHub.com, the ...
/networks/:owner/:repo/events:
options: []
parameters:
- name: owner
required: 1
summary: Name of the owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List public events for a network of repositories....
/notifications:
options:
- name: q-all
required: ~
summary: True to show notifications marked as read.
type: boolean
- name: q-participating
required: ~
summary: |
True to show only notifications in which the user is directly participating
or mentioned.
type: boolean
- name: q-since
required: ~
summary: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
type: string
parameters: []
summary: List your notifications.
/notifications/threads/:id:
options: []
parameters:
- name: id
required: 1
summary: Id of thread.
type: integer
summary: View a single thread.
/notifications/threads/:id/subscription:
options: []
parameters:
- name: id
required: 1
summary: Id of thread.
type: integer
summary: Get a Thread Subscription.
/orgs/:org:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: Get an Organization.
/orgs/:org/events:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: List public events for an organization....
/orgs/:org/issues:
options:
- enum: *10
name: q-filter
required: 1
summary: |
Issues assigned to you / created by you / mentioning you / you're
subscribed to updates for / All issues the authenticated user can see
type: string
- enum: *11
name: q-state
required: 1
summary: ~
type: string
- name: q-labels
required: 1
summary: String list of comma separated Label names. Example - bug,ui,@high.
type: string
- enum: *12
name: q-sort
required: 1
summary: ~
type: string
- enum: *13
name: q-direction
required: 1
summary: ~
type: string
- name: q-since
required: ~
summary: |
Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only issues updated at or after this time are returned.
type: string
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: List issues.
/orgs/:org/members:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: Members list.
/orgs/:org/members/:username:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
- name: username
required: 1
summary: Name of the user.
type: string
summary: Check if a user is, publicly or privately, a membe...
/orgs/:org/public_members:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: Public members list.
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: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get the last year of commit activity data....
/repos/:owner/:repo/stats/contributors:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get contributors list with additions, deletions, a...
/repos/:owner/:repo/stats/participation:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get the weekly commit count for the repo owner and...
/repos/:owner/:repo/stats/punch_card:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get the number of commits per hour in each day....
/repos/:owner/:repo/statuses/:ref:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: ref
required: 1
summary: |
Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.
type: string
summary: List Statuses for a specific Ref....
/repos/:owner/:repo/subscribers:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List watchers.
/repos/:owner/:repo/subscription:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get a Repository Subscription.
/repos/:owner/:repo/tags:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get list of tags.
/repos/:owner/:repo/teams:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Get list of teams
/repos/:owner/:repo/watchers:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List Stargazers. New implementation....
/repositories:
options:
- name: q-since
required: ~
summary: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
type: string
parameters: []
summary: List all public repositories.
/search/code:
options:
- enum: *26
examples/githubcl-appspec.yaml view on Meta::CPAN
- 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:
examples/githubcl-appspec.yaml view on Meta::CPAN
type: string
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List a users gists.
/users/:username/keys:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List public keys for a user.
/users/:username/orgs:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List all public organizations for a user....
/users/:username/received_events:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: These are events that you'll only see public event...
/users/:username/received_events/public:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List public events that a user has received...
/users/:username/repos:
options:
- enum: *40
name: q-type
required: ~
summary: ~
type: string
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List public repositories for the specified user....
/users/:username/starred:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List repositories being starred by a user....
/users/:username/subscriptions:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List repositories being watched by a user....
summary: GET call
PATCH:
op: apicall
subcommands:
/gists/:id:
options: []
parameters:
- name: id
required: 1
summary: Id of gist.
type: integer
summary: Edit a gist.
/gists/:id/comments/:commentId:
options: []
parameters:
- name: id
required: 1
summary: Id of gist.
type: integer
- name: commentId
required: 1
summary: Id of comment.
type: integer
summary: Edit a comment.
/notifications/threads/:id:
options: []
parameters:
- name: id
required: 1
summary: Id of thread.
type: integer
summary: Mark a thread as read
/orgs/:org:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: Edit an Organization.
/repos/:owner/:repo:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Edit repository.
/repos/:owner/:repo/comments/:commentId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: commentId
examples/githubcl-appspec.yaml view on Meta::CPAN
- 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.
examples/githubcl-appspec.yaml view on Meta::CPAN
/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
required: 1
summary: Name of repository.
type: string
- name: path
required: 1
summary: ~
type: string
summary: Create a file.
/repos/:owner/:repo/issues/:number/labels:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Number of issue.
type: integer
summary: Replace all labels for an issue....
/repos/:owner/:repo/notifications:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Mark notifications as read in a repository....
/repos/:owner/:repo/pulls/:number/merge:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: number
required: 1
summary: Id of pull.
type: integer
summary: Merge a pull request (Merge Button's)...
/repos/:owner/:repo/subscription:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Set a Repository Subscription
/teams/:teamId/members/:username:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
- name: username
required: 1
summary: Name of a member.
type: string
summary: The API (described below) is deprecated and is sch...
/teams/:teamId/memberships/:username:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
- name: username
required: 1
summary: Name of a member.
type: string
summary: Add team membership.
/teams/:teamId/repos/:org/:repo:
options: []
parameters:
- name: teamId
required: 1
summary: Id of team.
type: integer
- name: org
required: 1
summary: Name of a organization.
type: string
- name: repo
required: 1
summary: Name of a repository.
type: string
summary: In order to add a repository to a team, the authen...
/user/following/:username:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: Follow a user.
/user/starred/:owner/:repo:
options: []
parameters:
- name: owner
required: 1
summary: Name of a repository owner.
type: string
- name: repo
required: 1
summary: Name of a repository.
type: string
summary: Star a repository.
/user/subscriptions/:owner/:repo:
options: []
parameters:
- name: owner
required: 1
summary: Name of the owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Watch a repository.
summary: PUT call
summary: |
Powerful collaboration, code review, and code management for open source and private projects.
title: GitHub
( run in 1.024 second using v1.01-cache-2.11-cpan-39bf76dae61 )