625 lines
21 KiB
JSON
625 lines
21 KiB
JSON
{
|
||
"constants": {
|
||
"name": "Github",
|
||
"description": "A Node.JS module, which provides an object oriented wrapper for the GitHub v3 API.",
|
||
"protocol": "https",
|
||
"host": "api.github.com",
|
||
"port": 443,
|
||
"documentation": "https://developer.github.com/v3",
|
||
"dateFormat": "YYYY-MM-DDTHH:MM:SSZ",
|
||
"requestFormat": "json",
|
||
"requestMedia": "application/vnd.github.v3+json"
|
||
},
|
||
"response-headers": [
|
||
"X-RateLimit-Limit",
|
||
"X-RateLimit-Remaining",
|
||
"X-RateLimit-Reset",
|
||
"X-Oauth-Scopes",
|
||
"X-Poll-Interval",
|
||
"X-GitHub-Request-Id",
|
||
"X-GitHub-Media-Type",
|
||
"X-GitHub-SSO",
|
||
"Retry-After",
|
||
"Link",
|
||
"Location",
|
||
"Last-Modified",
|
||
"Etag",
|
||
"Status"
|
||
],
|
||
"request-headers": [
|
||
"Authorization",
|
||
"If-Modified-Since",
|
||
"If-None-Match",
|
||
"Cookie",
|
||
"User-Agent",
|
||
"Accept",
|
||
"X-GitHub-OTP"
|
||
],
|
||
"params": {
|
||
"files": {
|
||
"type": "Json",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "Files that make up this gist. The key of which should be a required string filename and the value another required hash with parameters: 'content'"
|
||
},
|
||
"owner": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"username": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"org": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"repo": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"branch": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"sha": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"description": {
|
||
"type": "String",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"id": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"gist_id": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "Id (SHA1 hash) of the gist."
|
||
},
|
||
"installation_id": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"repository_id": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"commit_id": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "Sha of the commit to comment on.",
|
||
"description": "Sha of the commit to comment on."
|
||
},
|
||
"client_id": {
|
||
"type": "String",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "The 20 character OAuth app client key for which to create the token."
|
||
},
|
||
"column_id": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"project_id": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"repo_id": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"invitation_id": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"ref": {
|
||
"type": "String",
|
||
"required": true,
|
||
"allow-empty": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected."
|
||
},
|
||
"number": {
|
||
"type": "Number",
|
||
"required": true,
|
||
"validation": "^[0-9]+$",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"issue_number": {
|
||
"type": "Number",
|
||
"required": true,
|
||
"validation": "^[0-9]+$",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"name": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"direction": {
|
||
"type": "String",
|
||
"required": false,
|
||
"validation": "^(asc|desc)$",
|
||
"invalidmsg": "asc or desc, default: desc.",
|
||
"description": "",
|
||
"enum": [
|
||
"asc",
|
||
"desc"
|
||
],
|
||
"default": "desc"
|
||
},
|
||
"since": {
|
||
"type": "Date",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"
|
||
},
|
||
"until": {
|
||
"type": "Date",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"
|
||
},
|
||
"state": {
|
||
"type": "String",
|
||
"required": false,
|
||
"validation": "^(open|closed|all)$",
|
||
"invalidmsg": "open, closed, all, default: open",
|
||
"description": "",
|
||
"enum": [
|
||
"open",
|
||
"closed",
|
||
"all"
|
||
],
|
||
"default": "open"
|
||
},
|
||
"color": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "6 character hex code, without a leading #.",
|
||
"description": "6 character hex code, without a leading #."
|
||
},
|
||
"base": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo."
|
||
},
|
||
"head": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "The branch (or git ref) where your changes are implemented."
|
||
},
|
||
"path": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "Relative path of the file to comment on.",
|
||
"description": "Relative path of the file to comment on."
|
||
},
|
||
"position": {
|
||
"type": "Number",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "Column index in the diff to comment on.",
|
||
"description": "Column index in the diff to comment on."
|
||
},
|
||
"body": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"homepage": {
|
||
"type": "String",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"private": {
|
||
"type": "Boolean",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "True to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account. Default is false.",
|
||
"default": "false"
|
||
},
|
||
"has_issues": {
|
||
"type": "Boolean",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "True to enable issues for this repository, false to disable them. Default is true.",
|
||
"default": "true"
|
||
},
|
||
"has_projects": {
|
||
"type": "Boolean",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "True to enable projects for this repository, false to disable them. Default is true.",
|
||
"default": "true"
|
||
},
|
||
"has_wiki": {
|
||
"type": "Boolean",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "True to enable the wiki for this repository, false to disable it. Default is true.",
|
||
"default": "true"
|
||
},
|
||
"has_downloads": {
|
||
"type": "Boolean",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "True to enable downloads for this repository, false to disable them. Default is true.",
|
||
"default": "true"
|
||
},
|
||
"default_branch": {
|
||
"type": "String",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "Updates the default branch for this repository."
|
||
},
|
||
"title": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"key": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": ""
|
||
},
|
||
"page": {
|
||
"type": "Number",
|
||
"required": false,
|
||
"validation": "^[0-9]+$",
|
||
"invalidmsg": "",
|
||
"description": "Page number of the results to fetch."
|
||
},
|
||
"per_page": {
|
||
"type": "Number",
|
||
"required": false,
|
||
"validation": "^[0-9]+$",
|
||
"invalidmsg": "",
|
||
"description": "A custom page size up to 100. Default is 30.",
|
||
"default": "30"
|
||
},
|
||
"scopes": {
|
||
"type": "Array",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "A list of scopes that this authorization is in."
|
||
},
|
||
"note": {
|
||
"type": "String",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "A note to remind you what the OAuth token is for."
|
||
},
|
||
"note_url": {
|
||
"type": "String",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "A URL to remind you what app the OAuth token is for."
|
||
},
|
||
"auto_init": {
|
||
"type": "Boolean",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "True to create an initial commit with empty README. Default is false",
|
||
"default": "false"
|
||
},
|
||
"gitignore_template": {
|
||
"type": "String",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "Desired language or platform .gitignore template to apply. Ignored if auto_init parameter is not provided."
|
||
},
|
||
"license_template": {
|
||
"type": "String",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "Desired LICENSE template to apply. Use the name of the template without the extension. For example, \"mit\" or \"mozilla\"."
|
||
},
|
||
"order": {
|
||
"type": "String",
|
||
"required": false,
|
||
"validation": "^(asc|desc)$",
|
||
"invalidmsg": "The sort order if sort parameter is provided. One of asc or desc. Default: desc",
|
||
"description": "asc or desc",
|
||
"enum": [
|
||
"asc",
|
||
"desc"
|
||
],
|
||
"default": "desc"
|
||
},
|
||
"q": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "Search Term",
|
||
"combined": true
|
||
},
|
||
"data": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "Raw data to send as the body of the request"
|
||
},
|
||
"privacy": {
|
||
"type": "String",
|
||
"required": false,
|
||
"validation": "^(secret|closed)$",
|
||
"invalidmsg": "secret, closed, default: secret",
|
||
"description": "The level of privacy this team should have.",
|
||
"enum": [
|
||
"secret",
|
||
"closed"
|
||
],
|
||
"default": "secret"
|
||
},
|
||
"fingerprint": {
|
||
"type": "String",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "A unique string to distinguish an authorization from others created for the same client ID and user."
|
||
},
|
||
"access_token": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "OAuth token"
|
||
},
|
||
"assignees": {
|
||
"type": "Array",
|
||
"required": false,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise."
|
||
},
|
||
"url": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "Dynamic URL for release asset uploads returned by the release’s API response."
|
||
},
|
||
"contentType": {
|
||
"type": "String",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "The content type of a release asset upload."
|
||
},
|
||
"contentLength": {
|
||
"type": "Number",
|
||
"required": true,
|
||
"validation": "",
|
||
"invalidmsg": "",
|
||
"description": "Size of release asset upload in bytes."
|
||
}
|
||
},
|
||
"acceptTree": {
|
||
"application/vnd.github.giant-sentry-fist-preview+json": [
|
||
"/orgs/:org/blocks",
|
||
"/orgs/:org/blocks/:username",
|
||
"/user/blocks",
|
||
"/user/blocks/:username"
|
||
],
|
||
"application/vnd.github.scarlet-witch-preview+json": [
|
||
"/codes_of_conduct",
|
||
"/codes_of_conduct/:key",
|
||
"/repos/:owner/:repo",
|
||
"/repos/:owner/:repo/community/code_of_conduct"
|
||
],
|
||
"application/vnd.github.cloak-preview+json": [
|
||
"/search/commits"
|
||
],
|
||
"application/vnd.github.black-panther-preview+json": [
|
||
"/repos/:owner/:name/community/profile"
|
||
],
|
||
"application/vnd.github.ant-man-preview+json": [
|
||
"/repos/:owner/:repo/deployments",
|
||
"/repos/:owner/:repo/deployments/:id/statuses"
|
||
],
|
||
"application/vnd.github.cryptographer-preview": [
|
||
"/users/:username/gpg_keys",
|
||
"/user/gpg_keys",
|
||
"/user/gpg_keys/:id",
|
||
"/repos/:owner/:repo/commits/:sha"
|
||
],
|
||
"application/vnd.github.barred-rock-preview": [
|
||
"/repos/:owner/:repo/import/authors",
|
||
"/repos/:owner/:repo/import/authors/:author_id",
|
||
"/:owner/:name/import/lfs",
|
||
"/:owner/:name/import/large_files",
|
||
"/repos/:owner/:repo/import"
|
||
],
|
||
"application/vnd.github.machine-man-preview": [
|
||
"/app/installations",
|
||
"/installations/:installation_id/access_tokens",
|
||
"/installation/repositories",
|
||
"/installations/:installation_id/repositories/:repository_id",
|
||
"/apps/:app_slug",
|
||
"/app/installations/:installation_id",
|
||
"/user/installations",
|
||
"/user/installations/:installation_id/repositories/:repository_id"
|
||
],
|
||
"application/vnd.github.drax-preview+json": [
|
||
"/licenses",
|
||
"/licenses/:license",
|
||
"/repos/:owner/:repo",
|
||
"/repos/:owner/:repo/license"
|
||
],
|
||
"application/vnd.github.valkyrie-preview+json": [
|
||
"/marketplace_listing/plans",
|
||
"/marketplace_listing/stubbed/plans",
|
||
"/marketplace_listing/plans/:id/accounts",
|
||
"/marketplace_listing/stubbed/plans/:id/accounts",
|
||
"/marketplace_listing/accounts/:id",
|
||
"/marketplace_listing/stubbed/accounts/:id",
|
||
"/user/marketplace_purchases",
|
||
"/user/marketplace_purchases/stubbed"
|
||
],
|
||
"application/vnd.github.wyandotte-preview+json": [
|
||
"/orgs/:org/migrations",
|
||
"/orgs/:org/migrations/:id",
|
||
"/orgs/:org/migrations/:id/archive",
|
||
"/orgs/:org/migrations/:id/repos/:repo_name/lock"
|
||
],
|
||
"application/vnd.github.hellcat-preview+json": [
|
||
"/orgs/:org/teams",
|
||
"/teams/:id",
|
||
"/teams/:id/teams",
|
||
"/teams/:id/members",
|
||
"/teams/:id/memberships/:username",
|
||
"/teams/:id/repos",
|
||
"/teams/:id/repos/:owner/:repo",
|
||
"/teams/:id/repos/:org/:repo",
|
||
"/user/teams"
|
||
],
|
||
"application/vnd.github.mister-fantastic-preview+json": [
|
||
"/repos/:owner/:repo/pages",
|
||
"/repos/:owner/:repo/pages/builds",
|
||
"/repos/:owner/:repo/pages/builds/latest",
|
||
"/repos/:owner/:repo/pages/builds/:id"
|
||
],
|
||
"application/vnd.github.eye-scream-preview": [
|
||
"/admin/pre-receive-environments/:id",
|
||
"/admin/pre_receive_environments",
|
||
"/admin/pre-receive-environments/:id/downloads/latest",
|
||
"/admin/pre_receive_environments/:id/downloads",
|
||
"/admin/pre-receive-hooks/:id",
|
||
"/admin/pre-receive-hooks"
|
||
],
|
||
"application/vnd.github.inertia-preview+json": [
|
||
"/repos/:owner/:repo/projects",
|
||
"/orgs/:org/projects",
|
||
"/projects/:id",
|
||
"/projects/columns/:column_id/cards",
|
||
"/projects/columns/cards/:id",
|
||
"/projects/columns/cards/:id/moves",
|
||
"/projects/:project_id/columns",
|
||
"/projects/columns/:id",
|
||
"/projects/columns/:id/moves"
|
||
],
|
||
"application/vnd.github.polaris-preview": [
|
||
"/repos/:owner/:repo/pulls/:number/merge"
|
||
],
|
||
"application/vnd.github.squirrel-girl-preview": [
|
||
"/issues",
|
||
"/user/issues",
|
||
"/orgs/:org/issues",
|
||
"/repos/:owner/:repo/issues",
|
||
"/repos/:owner/:repo/issues/:number",
|
||
"/repos/:owner/:repo/comments/:id/reactions",
|
||
"/repos/:owner/:repo/issues/comments",
|
||
"/repos/:owner/:repo/issues/comments/:id",
|
||
"/repos/:owner/:repo/issues/:number/comments",
|
||
"/repos/:owner/:repo/issues/:number/reactions",
|
||
"/repos/:owner/:repo/issues/comments/:id/reactions",
|
||
"/repos/:owner/:repo/pulls/comments/:id/reactions",
|
||
"/reactions/:id",
|
||
"/repos/:owner/:repo/pulls/:number/comments",
|
||
"/repos/:owner/:repo/pulls/comments",
|
||
"/repos/:owner/:repo/pulls/comments/:id"
|
||
],
|
||
"application/vnd.github.thor-preview+json": [
|
||
"/repos/:owner/:repo/pulls/:number/requested_reviewers"
|
||
],
|
||
"application/vnd.github.v3.star+json": [
|
||
"/repos/:owner/:repo/stargazers",
|
||
"/users/:username/starred",
|
||
"/user/starred"
|
||
],
|
||
"application/vnd.github.mockingbird-preview": [
|
||
"/repos/:owner/:repo/issues/:issue_number/timeline"
|
||
],
|
||
"application/vnd.github.mercy-preview+json": [
|
||
"/repos/:owner/:repo/topics",
|
||
"/search/repositories"
|
||
]
|
||
}
|
||
}
|