API-CLI
view release on metacpan or search on metacpan
2. You may apply bug fixes, portability fixes and other modifications derived
from the Public Domain or from the Copyright Holder. A Package modified in such
a way shall still be considered the Standard Version.
3. You may otherwise modify your copy of this Package in any way, provided that
you insert a prominent notice in each changed file stating how and when you
changed that file, and provided that you do at least ONE of the following:
a) place your modifications in the Public Domain or otherwise make them
Freely Available, such as by posting said modifications to Usenet or an
equivalent medium, or placing the modifications on a major archive site
such as ftp.uu.net, or by allowing the Copyright Holder to include your
modifications in the Standard Version of the Package.
b) use the modified Package only within your corporation or organization.
c) rename any non-standard executables so the names do not conflict with
standard executables, which must also be provided, and provide a separate
manual page for each non-standard executable that clearly documents how it
differs from the Standard Version.
Makefile.PL view on Meta::CPAN
}
delete $WriteMakefileArgs{CONFIGURE_REQUIRES}
unless eval { ExtUtils::MakeMaker->VERSION(6.52) };
WriteMakefile(%WriteMakefileArgs);
{
package
MY;
use File::ShareDir::Install qw(postamble);
}
examples/digitaloceancl-appspec.yaml view on Meta::CPAN
description: List all droplets
/droplets/:id:
get:
description: Retrieve a droplet by id
parameters:
- in: path
name: id
required: true
type: integer
/droplets/:id/actions:
post:
description: Trigger droplet action
parameters:
- description: action type
in: body
name: type
required: true
type:
enum:
- rename
- description: new droplet name
examples/digitaloceancl-openapi.yaml view on Meta::CPAN
description: List all droplets
/droplets/:id:
get:
description: Retrieve a droplet by id
parameters:
- name: id
type: integer
required: true
in: path
/droplets/:id/actions:
post:
description: Trigger droplet action
parameters:
- name: type
in: body
description: action type
required: true
type:
enum:
- rename
- name: name
examples/githubcl-appspec.yaml view on Meta::CPAN
company:
type: string
email:
description: Publicly visible email address.
type: string
location:
type: string
name:
type: string
type: object
postComment:
properties:
body:
type: string
required:
- body
type: object
postGist:
properties:
description:
type: string
files:
properties:
file1.txt:
properties:
content:
type: string
type: object
type: object
public:
type: boolean
type: object
postRepo:
properties:
auto_init:
description: True to create an initial commit with empty README. Default
is false.
type: boolean
description:
type: string
gitignore_template:
description: 'Desired language or platform .gitignore template to apply.
Use the name of the template without the extension. For example, "Haskell"
examples/githubcl-appspec.yaml view on Meta::CPAN
properties:
id:
type: integer
key:
type: string
title:
type: string
url:
type: string
type: object
user-keys-post:
properties:
key:
type: string
title:
type: string
type: object
user-update:
properties:
bio:
type: string
examples/githubcl-appspec.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gists'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a gist.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
examples/githubcl-appspec.yaml view on Meta::CPAN
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/postGist'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/gist'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/gists/public:
examples/githubcl-appspec.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/comments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a commen
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
examples/githubcl-appspec.yaml view on Meta::CPAN
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
examples/githubcl-appspec.yaml view on Meta::CPAN
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
examples/githubcl-appspec.yaml view on Meta::CPAN
produces:
- text/html
responses:
'200':
description: OK
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/markdown/raw:
post:
consumes:
- text/plain
description: Render a Markdown document in raw mode
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.
examples/githubcl-appspec.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repos'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a new repository for the authenticated user. OAuth users must supply
repo scope.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
examples/githubcl-appspec.yaml view on Meta::CPAN
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/postRepo'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/repos'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/orgs/{org}/teams:
examples/githubcl-appspec.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/teams'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create team.
In order to create a team, the authenticated user must be an owner of organization.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
examples/githubcl-appspec.yaml view on Meta::CPAN
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
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repoComments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a commit comment.
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
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repo-deployments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Users with push access can create a deployment for a given ref
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
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/deployment-statuses'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a Deployment Status
Users with push access can create deployment statuses for a given deployment:
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
examples/githubcl-appspec.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/forks'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a fork.
Forking a Repository happens asynchronously. Therefore, you may have to wai
a short period before accessing the git objects. If this takes longer than 5
minutes, be sure to contact Support.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
examples/githubcl-appspec.yaml view on Meta::CPAN
responses:
'201':
description: Created
schema:
$ref: '#/definitions/fork'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/git/blobs:
post:
description: Create a Blob.
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
responses:
'200':
description: OK
schema:
$ref: '#/definitions/blob'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/git/commits:
post:
description: Create a Commit.
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
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/refs'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a Reference
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
responses:
'200':
description: OK
schema:
$ref: '#/definitions/headBranch'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/git/tags:
post:
description: |
Create a Tag Object.
Note that creating a tag object does not create the reference that makes a
tag in Git. If you want to create an annotated tag in Git, you have to do
this call to create the tag object, and then create the refs/tags/[tag]
reference. If you want to create a lightweight tag, you only have to create
the tag reference - this call would be unnecessary.
parameters:
- description: Name of repository owner.
in: path
examples/githubcl-appspec.yaml view on Meta::CPAN
responses:
'200':
description: OK
schema:
$ref: '#/definitions/tag'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/git/trees:
post:
description: |
Create a Tree.
The tree creation API will take nested entries as well. If both a tree and
a nested path modifying that tree are specified, it will overwrite the
contents of that tree with the new path contents and write a new tree out.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
examples/githubcl-appspec.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/hook'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a hook.
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
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
examples/githubcl-appspec.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/issues'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create an issue.
Any user with pull access to a repository can create an issue.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
examples/githubcl-appspec.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/issuesComments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a comment.
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
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/labels'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Add labels to an issue.
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
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/keys'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a key.
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
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/user-keys-post'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/user-keys-keyId'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/repos/{owner}/{repo}/keys/{keyId}:
examples/githubcl-appspec.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/labels'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a label.
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
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
examples/githubcl-appspec.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/milestone'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a milestone.
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
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.
post:
description: Create a pull request.
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
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/pullsComment'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a comment.
#TODO Alternative input ( http://developer.github.com/v3/pulls/comments/ )
description: |
Alternative Input.
Instead of passing commit_id, path, and position you can reply to an
existing Pull Request Comment like this:
body
Required string
examples/githubcl-appspec.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/releases'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a release
Users with push access to the repository can create a release.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
examples/githubcl-appspec.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
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
examples/githubcl-appspec.yaml view on Meta::CPAN
- application/vnd.github.v3
responses:
'200':
description: OK
schema:
$ref: '#/definitions/user-emails'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Add email address(es).
You can post a single email address or an array of addresses.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
examples/githubcl-appspec.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gitignore'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a public key.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
examples/githubcl-appspec.yaml view on Meta::CPAN
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/user-keys-post'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/user-keys-keyId'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/keys/{keyId}:
examples/githubcl-appspec.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repos'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a new repository for the authenticated user. OAuth users must supply
repo scope.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
examples/githubcl-appspec.yaml view on Meta::CPAN
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/postRepo'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/repos'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/starred:
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gists'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a gist.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
examples/githubcl-openapi.yaml view on Meta::CPAN
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/postGist'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/gist'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/gists/public:
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/comments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a commen
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
examples/githubcl-openapi.yaml view on Meta::CPAN
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
examples/githubcl-openapi.yaml view on Meta::CPAN
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
examples/githubcl-openapi.yaml view on Meta::CPAN
produces:
- text/html
responses:
'200':
description: OK
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/markdown/raw:
post:
consumes:
- text/plain
description: Render a Markdown document in raw mode
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.
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repos'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a new repository for the authenticated user. OAuth users must supply
repo scope.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
examples/githubcl-openapi.yaml view on Meta::CPAN
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/postRepo'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/repos'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/orgs/{org}/teams':
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/teams'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create team.
In order to create a team, the authenticated user must be an owner of organization.
parameters:
- description: Name of organisation.
in: path
name: org
required: true
type: string
- description: |
examples/githubcl-openapi.yaml view on Meta::CPAN
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-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repoComments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a commit comment.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repo-deployments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Users with push access can create a deployment for a given ref
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/deployment-statuses'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a Deployment Status
Users with push access can create deployment statuses for a given deployment:
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/forks'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a fork.
Forking a Repository happens asynchronously. Therefore, you may have to wai
a short period before accessing the git objects. If this takes longer than 5
minutes, be sure to contact Support.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
examples/githubcl-openapi.yaml view on Meta::CPAN
responses:
'201':
description: Created
schema:
$ref: '#/definitions/fork'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/git/blobs':
post:
description: Create a Blob.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
examples/githubcl-openapi.yaml view on Meta::CPAN
responses:
'200':
description: OK
schema:
$ref: '#/definitions/blob'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/git/commits':
post:
description: Create a Commit.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/refs'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a Reference
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
examples/githubcl-openapi.yaml view on Meta::CPAN
responses:
'200':
description: OK
schema:
$ref: '#/definitions/headBranch'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/git/tags':
post:
description: |
Create a Tag Object.
Note that creating a tag object does not create the reference that makes a
tag in Git. If you want to create an annotated tag in Git, you have to do
this call to create the tag object, and then create the refs/tags/[tag]
reference. If you want to create a lightweight tag, you only have to create
the tag reference - this call would be unnecessary.
parameters:
- description: Name of repository owner.
in: path
examples/githubcl-openapi.yaml view on Meta::CPAN
responses:
'200':
description: OK
schema:
$ref: '#/definitions/tag'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/git/trees':
post:
description: |
Create a Tree.
The tree creation API will take nested entries as well. If both a tree and
a nested path modifying that tree are specified, it will overwrite the
contents of that tree with the new path contents and write a new tree out.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/hook'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a hook.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
examples/githubcl-openapi.yaml view on Meta::CPAN
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
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/issues'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create an issue.
Any user with pull access to a repository can create an issue.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/issuesComments'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a comment.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/labels'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Add labels to an issue.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/keys'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a key.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
examples/githubcl-openapi.yaml view on Meta::CPAN
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/user-keys-post'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/user-keys-keyId'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/repos/{owner}/{repo}/keys/{keyId}':
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/labels'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a label.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
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
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/milestone'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a milestone.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
examples/githubcl-openapi.yaml view on Meta::CPAN
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.
post:
description: Create a pull request.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
in: path
name: repo
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/pullsComment'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a comment.
#TODO Alternative input ( http://developer.github.com/v3/pulls/comments/ )
description: |
Alternative Input.
Instead of passing commit_id, path, and position you can reply to an
existing Pull Request Comment like this:
body
Required string
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/releases'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a release
Users with push access to the repository can create a release.
parameters:
- description: Name of repository owner.
in: path
name: owner
required: true
type: string
- description: Name of repository.
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
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
examples/githubcl-openapi.yaml view on Meta::CPAN
- application/vnd.github.v3
responses:
'200':
description: OK
schema:
$ref: '#/definitions/user-emails'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Add email address(es).
You can post a single email address or an array of addresses.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
type: string
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/gitignore'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: Create a public key.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
in: header
name: Accept
examples/githubcl-openapi.yaml view on Meta::CPAN
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/user-keys-post'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/user-keys-keyId'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
'/user/keys/{keyId}':
examples/githubcl-openapi.yaml view on Meta::CPAN
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/repos'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
post:
description: |
Create a new repository for the authenticated user. OAuth users must supply
repo scope.
parameters:
- description: |
You can check the current version of media type in responses.
in: header
name: X-GitHub-Media-Type
type: string
- description: Is used to set specified media type.
examples/githubcl-openapi.yaml view on Meta::CPAN
- in: header
name: X-RateLimit-Reset
type: integer
- in: header
name: X-GitHub-Request-Id
type: integer
- in: body
name: body
required: true
schema:
$ref: '#/definitions/postRepo'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/repos'
'403':
description: |
API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
for details.
/user/starred:
examples/githubcl-openapi.yaml view on Meta::CPAN
company:
type: string
email:
description: Publicly visible email address.
type: string
location:
type: string
name:
type: string
type: object
postComment:
properties:
body:
type: string
required:
- body
type: object
postGist:
properties:
description:
type: string
files:
properties:
file1.txt:
properties:
content:
type: string
type: object
type: object
public:
type: boolean
type: object
postRepo:
properties:
auto_init:
description: True to create an initial commit with empty README. Default is false.
type: boolean
description:
type: string
gitignore_template:
description: 'Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell" Ignored if auto_init parameter is not provided. '
type: string
has_downloads:
examples/githubcl-openapi.yaml view on Meta::CPAN
properties:
id:
type: integer
key:
type: string
title:
type: string
url:
type: string
type: object
user-keys-post:
properties:
key:
type: string
title:
type: string
type: object
user-update:
properties:
bio:
type: string
examples/metacpancl-appspec.yaml view on Meta::CPAN
/distribution/:distribution:
get:
description: Distribution information not specific to a version
parameters:
- description: distribution name
in: path
name: distribution
required: true
type: string
/file:
post:
description: file
parameters:
- description: query
in: body
name: body
required: true
type: object
/module/:module:
get:
description: Module information
examples/metacpancl-openapi.yaml view on Meta::CPAN
in: query
type: string
description: resultset fields
-
name: size
in: query
type: integer
description: how many results
/file:
post:
description: file
parameters:
-
name: body
in: body
type: object
required: true
description: query
# vim:et:sts=2:sws=2:sw=2:foldmethod=indent
( run in 2.264 seconds using v1.01-cache-2.11-cpan-ceb78f64989 )