API-CLI
view release on metacpan or search on metacpan
examples/githubcl-appspec.yaml view on Meta::CPAN
type: object
type: object
body:
type: string
commit_id:
type: string
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
id:
type: integer
path:
type: string
position:
type: integer
updated_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
url:
type: string
user:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: object
type: array
pullsPost:
properties:
base:
type: string
body:
type: string
head:
type: string
title:
type: string
type: object
punchCardStats:
items:
type: integer
type: array
putSubscription:
properties:
created_at:
type: string
ignored:
type: boolean
reason:
type: object
subscribed:
type: boolean
thread_url:
type: string
url:
type: string
type: object
rate_limit:
properties:
rate:
properties:
limit:
type: integer
remaining:
type: integer
reset:
type: integer
type: object
readme:
properties:
_links:
properties:
git:
type: string
html:
type: string
self:
type: string
type: object
content:
type: string
encoding:
type: string
git_url:
type: string
html_url:
type: string
name:
type: string
path:
type: string
sha:
type: string
size:
type: integer
type:
type: string
url:
type: string
type: object
ref:
items:
properties:
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
creator:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
examples/githubcl-appspec.yaml view on Meta::CPAN
type: integer
repos:
type: integer
score:
type: number
type:
type: string
username:
type: string
type: object
type: array
type: object
stargazers:
items:
properties:
avatar_url:
type: string
gravatar_id:
type: string
id:
type: integer
login:
type: string
url:
type: string
type: object
type: array
subscribition:
properties:
created_at:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
ignored:
type: boolean
reason:
type: string
repository_url:
type: string
subscribed:
type: boolean
url:
type: string
type: object
subscribitionBody:
properties:
ignored:
type: boolean
subscribed:
type: boolean
type: object
subscription:
properties:
created_at:
type: string
ignored:
type: boolean
reason:
type: boolean
subscribed:
type: boolean
thread_url:
type: string
url:
type: string
type: object
tag:
properties:
message:
type: string
object:
properties:
sha:
type: string
type:
type: string
url:
type: string
type: object
sha:
type: string
tag:
type: string
tagger:
properties:
date:
description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
type: string
email:
type: string
name:
type: string
type: object
url:
type: string
type: object
tags:
properties:
message:
description: String of the tag message.
type: string
object:
description: String of the SHA of the git object this is tagging.
type: string
tag:
type: string
tagger:
properties:
date:
description: Timestamp of when this object was tagged.
type: string
email:
description: String of the email of the author of the tag.
type: string
name:
description: String of the name of the author of the tag.
type: string
type: object
type:
description: String of the type of the object we’re tagging. Normally this
is a commit but it can also be a tree or a blob.
type: string
examples/githubcl-appspec.yaml view on Meta::CPAN
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/notifications'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
put:
description: |
Mark as read.
Marking a notification as "read" removes it from the default view on GitHub.com.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/notificationMarkRead'
responses:
'205':
description: Marked as read.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/notifications/threads/{id}:
get:
description: View a single thread.
parameters:
- description: Id of thread.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/notifications'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
patch:
description: Mark a thread as read
parameters:
- description: Id of thread.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'205':
description: Thread marked as read.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/notifications/threads/{id}/subscription:
delete:
description: Delete a Thread Subscription.
parameters:
- description: Id of thread.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: "No Content\n"
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Get a Thread Subscription.
parameters:
- description: Id of thread.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/subscription'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
put:
description: |
Set a Thread Subscription.
This lets you subscribe to a thread, or ignore it. Subscribing to a thread
is unnecessary if the user is already subscribed to the repository. Ignoring
a thread will mute all future notifications (until you comment or get @mentioned).
parameters:
- description: Id of thread.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/putSubscription'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/subscription'
'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
examples/githubcl-appspec.yaml view on Meta::CPAN
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:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
examples/githubcl-appspec.yaml view on Meta::CPAN
/legacy/user/search/:keyword:
options:
- enum: *8
name: q-order
required: ~
summary: The sort field. if sort param is provided. Can be either asc or
desc.
type: string
- name: q-start_page
required: ~
summary: The page number to fetch
type: string
- enum: *9
name: q-sort
required: ~
summary: 'The sort field. One of stars, forks, or updated. Default: results
are sorted by best match.'
type: string
parameters:
- name: keyword
required: 1
summary: The search term
type: string
summary: Find users by keyword.
/meta:
options: []
parameters: []
summary: This gives some information about GitHub.com, the ...
/networks/:owner/:repo/events:
options: []
parameters:
- name: owner
required: 1
summary: Name of the owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List public events for a network of repositories....
/notifications:
options:
- name: q-all
required: ~
summary: True to show notifications marked as read.
type: boolean
- name: q-participating
required: ~
summary: |
True to show only notifications in which the user is directly participating
or mentioned.
type: boolean
- name: q-since
required: ~
summary: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
type: string
parameters: []
summary: List your notifications.
/notifications/threads/:id:
options: []
parameters:
- name: id
required: 1
summary: Id of thread.
type: integer
summary: View a single thread.
/notifications/threads/:id/subscription:
options: []
parameters:
- name: id
required: 1
summary: Id of thread.
type: integer
summary: Get a Thread Subscription.
/orgs/:org:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: Get an Organization.
/orgs/:org/events:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: List public events for an organization....
/orgs/:org/issues:
options:
- enum: *10
name: q-filter
required: 1
summary: |
Issues assigned to you / created by you / mentioning you / you're
subscribed to updates for / All issues the authenticated user can see
type: string
- enum: *11
name: q-state
required: 1
summary: ~
type: string
- name: q-labels
required: 1
summary: String list of comma separated Label names. Example - bug,ui,@high.
type: string
- enum: *12
name: q-sort
required: 1
summary: ~
type: string
- enum: *13
name: q-direction
required: 1
summary: ~
type: string
- name: q-since
required: ~
summary: |
Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only issues updated at or after this time are returned.
type: string
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: List issues.
/orgs/:org/members:
options: []
examples/githubcl-appspec.yaml view on Meta::CPAN
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List public events that a user has received...
/users/:username/repos:
options:
- enum: *40
name: q-type
required: ~
summary: ~
type: string
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List public repositories for the specified user....
/users/:username/starred:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List repositories being starred by a user....
/users/:username/subscriptions:
options: []
parameters:
- name: username
required: 1
summary: Name of user.
type: string
summary: List repositories being watched by a user....
summary: GET call
PATCH:
op: apicall
subcommands:
/gists/:id:
options: []
parameters:
- name: id
required: 1
summary: Id of gist.
type: integer
summary: Edit a gist.
/gists/:id/comments/:commentId:
options: []
parameters:
- name: id
required: 1
summary: Id of gist.
type: integer
- name: commentId
required: 1
summary: Id of comment.
type: integer
summary: Edit a comment.
/notifications/threads/:id:
options: []
parameters:
- name: id
required: 1
summary: Id of thread.
type: integer
summary: Mark a thread as read
/orgs/:org:
options: []
parameters:
- name: org
required: 1
summary: Name of organisation.
type: string
summary: Edit an Organization.
/repos/:owner/:repo:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: Edit repository.
/repos/:owner/:repo/comments/:commentId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: commentId
required: 1
summary: Id of comment.
type: integer
summary: Update a commit comment.
/repos/:owner/:repo/git/refs/:ref:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: ref
required: 1
summary: ~
type: string
summary: Update a Reference
/repos/:owner/:repo/hooks/:hookId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
examples/githubcl-appspec.yaml view on Meta::CPAN
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.
( run in 0.755 second using v1.01-cache-2.11-cpan-39bf76dae61 )