API-CLI
view release on metacpan or search on metacpan
examples/githubcl-openapi.yaml view on Meta::CPAN
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/comment'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/comment'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/gists/{id}/forks':
post:
description: Fork a gist.
parameters:
- description: Id of gist.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Exists.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: Not exists.
'/gists/{id}/star':
delete:
description: Unstar a gist.
parameters:
- description: Id of gist.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Item removed.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Check if a gist is starred.
parameters:
- description: Id of gist.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Exists.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: Not exists.
put:
description: Star a gist.
parameters:
- description: Id of gist.
in: path
name: id
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Starred.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/gitignore/templates:
get:
description: |
Listing available templates.
List all templates available to pass as an option when creating a repository.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: 'Check if a user is, publicly or privately, a member of the organization.'
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: Name of the user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: |
No content. Response if requester is an organization member and user is a member
'302':
description: |
Found. Response if requester is not an organization member
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: |
Not Found.
a. Response if requester is an organization member and user is not a member
b. Response if requester is not an organization member and is inquiring about themselves
'/orgs/{org}/public_members':
get:
description: |
Public members list.
Members of an organization can choose to have their membership publicized
or not.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/orgs/{org}/public_members/{username}':
delete:
description: Conceal a user's membership.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: Name of the user.
in: path
name: username
required: true
type: string
examples/githubcl-openapi.yaml view on Meta::CPAN
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Concealed.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Check public membership.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: Name of the user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: User is a public member.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: User is not a public member.
put:
description: Publicize a user's membership.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: Name of the user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Publicized.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/orgs/{org}/repos':
get:
description: List repositories for the specified org.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- default: all
enum:
- all
- public
- private
- forks
- sources
- member
in: query
examples/githubcl-openapi.yaml view on Meta::CPAN
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/assignees'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/assignees/{assignee}':
get:
description: |
Check assignee.
You may also check to see if a particular user is an assignee for a repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Login of the assignee.
in: path
name: assignee
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: User is an assignee.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: User isn't an assignee.
'/repos/{owner}/{repo}/branches':
get:
description: Get list of branches
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/branches'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/branches/{branch}':
get:
description: Get Branch
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Name of the branch.
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Collaborator removed.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Check if user is a collaborator
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Login of the user.
in: path
name: user
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: User is a collaborator.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: User is not a collaborator.
put:
description: Add collaborator.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Login of the user.
in: path
name: user
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Collaborator added.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/comments':
get:
description: |
List commit comments for a repository.
Comments are ordered by ascending ID.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
examples/githubcl-openapi.yaml view on Meta::CPAN
responses:
'200':
description: OK
schema:
$ref: '#/definitions/languages'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/merges':
post:
description: Perform a merge.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/mergesBody'
responses:
'201':
description: Successful Response (The resulting merge commit)
schema:
$ref: '#/definitions/mergesSuccessful'
'204':
description: 'No-op response (base already contains the head, nothing to merge)'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: Missing base response or missing head response
schema:
$ref: '#/definitions/mergesConflict'
'409':
description: Merge conflict response.
schema:
$ref: '#/definitions/mergesConflict'
'/repos/{owner}/{repo}/milestones':
get:
description: List milestones for a repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- default: open
description: String to filter by state.
enum:
- open
- closed
in: query
name: state
type: string
- description: Ignored without 'sort' parameter.
in: query
name: direction
type: string
- default: due_date
description: ''
enum:
- due_date
- completeness
in: query
name: sort
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/pulls'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/pulls/{number}/merge':
get:
description: Get if a pull request has been merged.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of pull.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Pull request has been merged.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: Pull request has not been merged.
put:
description: Merge a pull request (Merge Button's)
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: Id of pull.
in: path
name: number
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/mergePullBody'
responses:
'200':
description: Response if merge was successful.
schema:
$ref: '#/definitions/merge'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'405':
description: Response if merge cannot be performed.
schema:
$ref: '#/definitions/merge'
'/repos/{owner}/{repo}/readme':
get:
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Team member removed.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: |
The "Get team member" API is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Get team membership API instead. It allows you to get both active and pending memberships.
Get team member.
In order to get if a user is a member of a team, the authenticated user mus
be a member of the team.
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: Name of a member.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: User is a member.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: User is not a member.
put:
description: |
The API (described below) is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Add team membership API instead. It allows you to invite new organization members to your teams.
Add team member.
In order to add a user to a team, the authenticated user must have 'admin'
permissions to the team or be an owner of the org that the team is associated
with.
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: Name of a member.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Team member added.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'422':
description: 'If you attempt to add an organization to a team, you will get this.'
schema:
$ref: '#/definitions/organizationAsTeamMember'
'/teams/{teamId}/memberships/{username}':
delete:
description: |
Remove team membership.
In order to remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. NOTE: This does not delete the user, it just remo...
parameters:
- description: Id of team.
in: path
examples/githubcl-openapi.yaml view on Meta::CPAN
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Team member removed.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: |
Get team membership.
In order to get a user's membership with a team, the authenticated user must be a member of the team or an owner of the team's organization.
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: Name of a member.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: User is a member.
schema:
$ref: '#/definitions/teamMembership'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: User has no membership with team
put:
description: |
Add team membership.
In order to add a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with.
If the user is already a part of the team's organization (meaning they're on at least one other team in the organization), this endpoint will add the user to the team.
If the user is completely unaffiliated with the team's organization (meaning they're on none of the organization's teams), this endpoint will send an invitation to the user via email. This newly-created membership will be in the 'pending' sta...
parameters:
- description: Id of team.
in: path
name: teamId
required: true
type: integer
- description: Name of a member.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: Team member added.
schema:
$ref: '#/definitions/teamMembership'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'422':
description: 'If you attempt to add an organization to a team, you will get this.'
schema:
$ref: '#/definitions/organizationAsTeamMember'
'/teams/{teamId}/repos':
get:
description: List team repos
parameters:
- description: Id of team.
in: path
examples/githubcl-openapi.yaml view on Meta::CPAN
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: User unfollowed.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Check if you are following a user.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Response if you are following this user.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: Response if you are not following this user.
put:
description: |
Follow a user.
Following a user requires the user to be logged in and authenticated with
basic auth or OAuth with the user:follow scope.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: You are now following the user.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/issues:
get:
description: |
List issues.
List all issues across owned and member repositories for the authenticated
user.
parameters:
- default: all
description: |
Issues assigned to you / created by you / mentioning you / you're
subscribed to updates for / All issues the authenticated user can see
enum:
- assigned
- created
- mentioned
- subscribed
- all
in: query
name: filter
required: true
examples/githubcl-openapi.yaml view on Meta::CPAN
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Unstarred.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Check if you are starring a repository.
parameters:
- description: Name of a repository owner.
in: path
name: owner
required: true
type: string
- description: Name of a repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: This repository is starred by you.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: This repository is not starred by you.
put:
description: Star a repository.
parameters:
- description: Name of a repository owner.
in: path
name: owner
required: true
type: string
- description: Name of a repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Repository starred.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/subscriptions:
get:
description: List repositories being watched by the authenticated user.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
examples/githubcl-openapi.yaml view on Meta::CPAN
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Unwatched.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
get:
description: Check if you are watching a repository.
parameters:
- description: Name of the owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Repository is watched by you.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: Repository is not watched by you.
put:
description: Watch a repository.
parameters:
- description: Name of the owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Repository is watched.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/teams:
get:
description: List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user or repo scope when authenticating via OAuth.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
examples/githubcl-openapi.yaml view on Meta::CPAN
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/users/{username}/following/{targetUser}':
get:
description: Check if one user follows another.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: Name of user.
in: path
name: targetUser
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'204':
description: Response if user follows target user.
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'404':
description: Response if user does not follow target user.
'/users/{username}/gists':
get:
description: List a users gists.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
in: query
name: since
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gists'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/users/{username}/keys':
get:
description: |
List public keys for a user.
Lists the verified public keys for a user. This is accessible by anyone.
parameters:
- description: Name of user.
in: path
name: username
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
( run in 0.530 second using v1.01-cache-2.11-cpan-39bf76dae61 )