API-CLI
view release on metacpan or search on metacpan
examples/githubcl-appspec.yaml view on Meta::CPAN
/legacy/issues/search/{owner}/{repository}/{state}/{keyword}:
get:
description: Find issues by state and keyword.
parameters:
- description: The search term.
in: path
name: keyword
required: true
type: string
- description: Indicates the state of the issues to return. Can be either
open or closed.
enum: &5
- open
- closed
in: path
name: state
required: true
type: string
- in: path
name: owner
required: true
type: string
- in: path
name: repository
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/search-issues-by-keyword'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/legacy/repos/search/{keyword}:
get:
description: Find repositories by keyword. Note, this legacy method does not
follow the v3 pagination pattern. This method returns up to 100 results
per page and pages can be fetched using the start_page parameter.
parameters:
- description: The search term
in: path
name: keyword
required: true
type: string
- default: desc
description: The sort field. if sort param is provided. Can be either asc
or desc.
enum: &6
- desc
- asc
in: query
name: order
type: string
- description: Filter results by language
in: query
name: language
type: string
- description: The page number to fetch
in: query
name: start_page
type: string
- description: 'The sort field. One of stars, forks, or updated. Default:
results are sorted by best match.'
enum: &7
- updated
- stars
- forks
in: query
name: sort
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/search-repositories-by-keyword'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/legacy/user/email/{email}:
get:
description: This API call is added for compatibility reasons only.
parameters:
- description: The email address
in: path
name: email
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/search-user-by-email'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/legacy/user/search/{keyword}:
get:
description: Find users by keyword.
parameters:
- description: The search term
in: path
name: keyword
required: true
type: string
- default: desc
description: The sort field. if sort param is provided. Can be either asc
or desc.
enum: &8
- desc
- asc
in: query
name: order
type: string
- description: The page number to fetch
in: query
name: start_page
type: string
- description: 'The sort field. One of stars, forks, or updated. Default:
results are sorted by best match.'
enum: &9
- updated
- stars
- forks
in: query
name: sort
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/search-users-by-keyword'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/markdown:
post:
description: Render an arbitrary Markdown document
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
examples/githubcl-appspec.yaml view on Meta::CPAN
- description: Id of comment.
in: path
name: commentId
required: true
type: integer
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/commentBody'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/commitComments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/commits:
get:
description: List commits on a repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
in: query
name: since
type: string
- description: Sha or branch to start listing commits from.
in: query
name: sha
type: string
- description: Only commits containing this file path will be returned.
in: query
name: path
type: string
- description: GitHub login, name, or email by which to filter by commit author.
in: query
name: author
type: string
- description: ISO 8601 Date - Only commits before this date will be returned.
in: query
name: until
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/commits'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/commits/{ref}/status:
get:
description: |
Get the combined Status for a specific Ref
The Combined status endpoint is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details.
To access this endpoint during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.she-hulk-preview+json
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
examples/githubcl-appspec.yaml view on Meta::CPAN
'200':
description: OK
schema:
$ref: '#/definitions/users'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/stats/code_frequency:
get:
description: |
Get the number of additions and deletions per week.
Returns a weekly aggregate of the number of additions and deletions pushed
to a repository.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/codeFrequencyStats'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/stats/commit_activity:
get:
description: |
Get the last year of commit activity data.
Returns the last year of commit activity grouped by week. The days array
is a group of commits per day, starting on Sunday.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
- in: header
name: X-RateLimit-Limit
type: integer
- in: header
name: X-RateLimit-Remaining
type: integer
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/commitActivityStats'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/stats/contributors:
get:
description: Get contributors list with additions, deletions, and commit counts.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
required: true
type: string
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
examples/githubcl-appspec.yaml view on Meta::CPAN
name: q-state
required: 1
summary: ~
type: string
- name: q-labels
required: 1
summary: String list of comma separated Label names. Example - bug,ui,@high.
type: string
- enum: *3
name: q-sort
required: 1
summary: ~
type: string
- enum: *4
name: q-direction
required: 1
summary: ~
type: string
- name: q-since
required: ~
summary: |
Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only issues updated at or after this time are returned.
type: string
parameters: []
summary: List issues.
/legacy/issues/search/:owner/:repository/:state/:keyword:
options: []
parameters:
- name: keyword
required: 1
summary: The search term.
type: string
- enum: *5
name: state
required: 1
summary: Indicates the state of the issues to return. Can be either open
or closed.
type: string
- name: owner
required: 1
summary: ~
type: string
- name: repository
required: 1
summary: ~
type: string
summary: Find issues by state and keyword....
/legacy/repos/search/:keyword:
options:
- enum: *6
name: q-order
required: ~
summary: The sort field. if sort param is provided. Can be either asc or
desc.
type: string
- name: q-language
required: ~
summary: Filter results by language
type: string
- name: q-start_page
required: ~
summary: The page number to fetch
type: string
- enum: *7
name: q-sort
required: ~
summary: 'The sort field. One of stars, forks, or updated. Default: results
are sorted by best match.'
type: string
parameters:
- name: keyword
required: 1
summary: The search term
type: string
summary: Find repositories by keyword. Note, this legacy me...
/legacy/user/email/:email:
options: []
parameters:
- name: email
required: 1
summary: The email address
type: string
summary: This API call is added for compatibility reasons o...
/legacy/user/search/:keyword:
options:
- enum: *8
name: q-order
required: ~
summary: The sort field. if sort param is provided. Can be either asc or
desc.
type: string
- name: q-start_page
required: ~
summary: The page number to fetch
type: string
- enum: *9
name: q-sort
required: ~
summary: 'The sort field. One of stars, forks, or updated. Default: results
are sorted by best match.'
type: string
parameters:
- name: keyword
required: 1
summary: The search term
type: string
summary: Find users by keyword.
/meta:
options: []
parameters: []
summary: This gives some information about GitHub.com, the ...
/networks/:owner/:repo/events:
options: []
parameters:
- name: owner
required: 1
summary: Name of the owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List public events for a network of repositories....
/notifications:
options:
- name: q-all
required: ~
summary: True to show notifications marked as read.
type: boolean
- name: q-participating
required: ~
summary: |
True to show only notifications in which the user is directly participating
or mentioned.
type: boolean
- name: q-since
required: ~
summary: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
type: string
parameters: []
summary: List your notifications.
/notifications/threads/:id:
options: []
parameters:
- name: id
required: 1
summary: Id of thread.
type: integer
summary: View a single thread.
/notifications/threads/:id/subscription:
examples/githubcl-appspec.yaml view on Meta::CPAN
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List.
/repos/:owner/:repo/collaborators/:user:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: user
required: 1
summary: Login of the user.
type: string
summary: Check if user is a collaborator...
/repos/:owner/:repo/comments:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List commit comments for a repository....
/repos/:owner/:repo/comments/:commentId:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: commentId
required: 1
summary: Id of comment.
type: integer
summary: Get a single commit comment.
/repos/:owner/:repo/commits:
options:
- name: q-since
required: ~
summary: |
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
type: string
- name: q-sha
required: ~
summary: Sha or branch to start listing commits from.
type: string
- name: q-path
required: ~
summary: Only commits containing this file path will be returned.
type: string
- name: q-author
required: ~
summary: GitHub login, name, or email by which to filter by commit author.
type: string
- name: q-until
required: ~
summary: ISO 8601 Date - Only commits before this date will be returned.
type: string
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
summary: List commits on a repository.
/repos/:owner/:repo/commits/:ref/status:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: ref
required: 1
summary: ~
type: string
summary: Get the combined Status for a specific Ref...
/repos/:owner/:repo/commits/:shaCode:
options: []
parameters:
- name: owner
required: 1
summary: Name of repository owner.
type: string
- name: repo
required: 1
summary: Name of repository.
type: string
- name: shaCode
required: 1
summary: SHA-1 code of the commit.
type: string
summary: Get a single commit.
/repos/:owner/:repo/commits/:shaCode/comments:
options: []
parameters:
- name: owner
required: 1
( run in 0.683 second using v1.01-cache-2.11-cpan-cdf2f3d4e48 )