From 77cf01cea9b95ac588b2d636f8c7dc6d480f0f0f Mon Sep 17 00:00:00 2001 From: Orta Therox Date: Thu, 16 Apr 2020 08:08:43 -0400 Subject: [PATCH] Release 10.1.1 --- package.json | 2 +- source/danger-incoming-process-schema.json | 8171 ++++++++++++++++++-- source/danger-outgoing-process-schema.json | 4 + 3 files changed, 7364 insertions(+), 813 deletions(-) diff --git a/package.json b/package.json index 5f9dbc779..2181901c4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "danger", - "version": "10.1.0", + "version": "10.1.1", "description": "Unit tests for Team Culture", "main": "distribution/danger.js", "typings": "distribution/danger.d.ts", diff --git a/source/danger-incoming-process-schema.json b/source/danger-incoming-process-schema.json index b234fd5f7..df6eedbc6 100644 --- a/source/danger-incoming-process-schema.json +++ b/source/danger-incoming-process-schema.json @@ -1,61 +1,34 @@ { "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { - "BitBucketServerCommit": { - "description": "A BitBucketServer specific implementation of a git commit.", + "BitBucketCloudCommit": { + "description": "A BitBucketCloud specific implementation of a git commit.", "properties": { "author": { "description": "The author of the commit, assumed to be the person who wrote the code.", "properties": { - "displayName": { - "description": "The display name of the commit author", - "type": "string" - }, - "emailAddress": { - "description": "The email of the commit author", - "type": "string" - }, - "name": { - "description": "The id of the commit author", - "type": "string" - } - }, - "type": "object" - }, - "authorTimestamp": { - "description": "The UNIX timestamp for when the commit was authored", - "type": "number" - }, - "committer": { - "description": "The author of the commit, assumed to be the person who committed/merged the code into a project.", - "properties": { - "displayName": { - "description": "The display name of the commit committer", - "type": "string" - }, - "emailAddress": { - "description": "The email of the commit committer", + "raw": { + "description": "Format: `Foo Bar `", "type": "string" }, - "name": { - "description": "The id of the commit committer", - "type": "string" + "user": { + "$ref": "#/definitions/BitBucketCloudUser" } }, "type": "object" }, - "committerTimestamp": { - "description": "When the commit was committed to the project", - "type": "number" - }, - "displayId": { - "description": "The shortened SHA for the commit", + "date": { + "description": "When the commit was committed to the project, in ISO 8601 format", "type": "string" }, - "id": { + "hash": { "description": "The SHA for the commit", "type": "string" }, + "links": { + "$ref": "#/definitions/BitBucketCloudLinks<\"html\">", + "description": "The commit's links" + }, "message": { "description": "The commit's message", "type": "string" @@ -64,11 +37,7 @@ "description": "The commit's parents", "items": { "properties": { - "displayId": { - "description": "The simplified sha", - "type": "string" - }, - "id": { + "hash": { "description": "The full SHA", "type": "string" } @@ -80,33 +49,46 @@ }, "type": "object" }, - "BitBucketServerJSONDSL": { + "BitBucketCloudContent": { + "properties": { + "html": { + "type": "string" + }, + "markup": { + "type": "string" + }, + "raw": { + "type": "string" + }, + "type": { + "enum": [ + "rendered" + ], + "type": "string" + } + }, + "type": "object" + }, + "BitBucketCloudJSONDSL": { "properties": { "activities": { "description": "The activities such as OPENING, CLOSING, MERGING or UPDATING a pull request", "items": { - "$ref": "#/definitions/BitBucketServerPRActivity" + "$ref": "#/definitions/BitBucketCloudPRActivity" }, "type": "array" }, "comments": { "description": "The comments on the pull request", "items": { - "$ref": "#/definitions/BitBucketServerPRActivity" + "$ref": "#/definitions/BitBucketCloudPRComment" }, "type": "array" }, "commits": { "description": "The commits associated with the pull request", "items": { - "$ref": "#/definitions/BitBucketServerCommit" - }, - "type": "array" - }, - "issues": { - "description": "The related JIRA issues", - "items": { - "$ref": "#/definitions/JIRAIssue" + "$ref": "#/definitions/BitBucketCloudCommit" }, "type": "array" }, @@ -115,189 +97,243 @@ "description": "The pull request and repository metadata" }, "pr": { - "$ref": "#/definitions/BitBucketServerPRDSL", + "$ref": "#/definitions/BitBucketCloudPRDSL", "description": "The PR metadata" } }, "type": "object" }, - "BitBucketServerLinks": { - "enum": [ - "clone", - "self" - ], - "type": "string" + "BitBucketCloudLinks<\"html\">": { + "properties": { + "html": { + "properties": { + "href": { + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" }, - "BitBucketServerMergeRef": { + "BitBucketCloudLinks<\"html\"|\"self\">": { "properties": { - "displayId": { - "type": "string" - }, - "id": { - "type": "string" - }, - "latestCommit": { - "type": "string" + "html": { + "properties": { + "href": { + "type": "string" + } + }, + "type": "object" }, - "repository": { - "$ref": "#/definitions/BitBucketServerRepo" + "self": { + "properties": { + "href": { + "type": "string" + } + }, + "type": "object" } }, "type": "object" }, - "BitBucketServerPRActivity": { + "BitBucketCloudLinks<\"html\"|\"self\"|\"decline\"|\"commits\"|\"comments\"|\"merge\"|\"activity\"|\"diff\"|\"approve\"|\"statuses\">": { "properties": { - "action": { - "enum": [ - "COMMENTED", - "DECLINED", - "MERGED", - "OPENED", - "UPDATED" - ], - "type": "string" - }, - "comment": { - "$ref": "#/definitions/BitBucketServerPRComment" - }, - "commentAction": { - "enum": [ - "ADDED", - "UPDATED" - ], - "type": "string" - }, - "commentAnchor": { + "activity": { "properties": { - "diffType": { - "enum": [ - "COMMIT", - "EFFECTIVE", - "RANGE", - "REQUIRED" - ], + "href": { "type": "string" - }, - "fileType": { - "enum": [ - "FROM", - "TO" - ], + } + }, + "type": "object" + }, + "approve": { + "properties": { + "href": { "type": "string" - }, - "fromHash": { + } + }, + "type": "object" + }, + "comments": { + "properties": { + "href": { "type": "string" - }, - "line": { - "type": "number" - }, - "lineType": { - "enum": [ - "ADDED", - "CONTEXT", - "REMOVED" - ], + } + }, + "type": "object" + }, + "commits": { + "properties": { + "href": { "type": "string" - }, - "path": { + } + }, + "type": "object" + }, + "decline": { + "properties": { + "href": { "type": "string" - }, - "srcPath": { + } + }, + "type": "object" + }, + "diff": { + "properties": { + "href": { "type": "string" - }, - "toHash": { + } + }, + "type": "object" + }, + "html": { + "properties": { + "href": { "type": "string" } }, "type": "object" }, - "createdDate": { - "type": "number" + "merge": { + "properties": { + "href": { + "type": "string" + } + }, + "type": "object" }, - "id": { - "type": "number" + "self": { + "properties": { + "href": { + "type": "string" + } + }, + "type": "object" }, - "user": { - "$ref": "#/definitions/BitBucketServerUser" + "statuses": { + "properties": { + "href": { + "type": "string" + } + }, + "type": "object" } }, "type": "object" }, - "BitBucketServerPRComment": { + "BitBucketCloudMergeRef": { "properties": { - "author": { - "$ref": "#/definitions/BitBucketServerUser" - }, - "comments": { - "items": { - "$ref": "#/definitions/BitBucketServerPRActivity" - }, - "type": "array" - }, - "createdDate": { - "type": "number" - }, - "id": { - "type": "number" - }, - "parent": { + "branch": { "properties": { - "id": { - "type": "number" + "name": { + "type": "string" } }, "type": "object" }, - "permittedOperations": { + "commit": { "properties": { - "deletable": { - "type": "boolean" - }, - "editable": { - "type": "boolean" + "hash": { + "type": "string" } }, "type": "object" }, - "text": { - "type": "string" - }, - "updatedDate": { - "type": "number" - }, - "version": { - "type": "number" + "repository": { + "$ref": "#/definitions/BitBucketCloudRepo" } }, "type": "object" }, - "BitBucketServerPRDSL": { - "description": "An exact copy of the PR's reference JSON. This interface has type'd the majority\nof it for tooling's sake, but any extra metadata which BitBucket Server send\nwill still be inside the JS object.", + "BitBucketCloudPRActivity": { "properties": { - "author": { - "allOf": [ - { - "$ref": "#/definitions/BitBucketServerPRParticipant" + "comment": { + "$ref": "#/definitions/BitBucketCloudPRComment" + }, + "pull_request": { + "properties": { + "id": { + "type": "number" }, - { - "properties": { - "role": { - "enum": [ - "AUTHOR" - ], - "type": "string" - } - }, - "type": "object" + "title": { + "type": "string" } - ], - "description": "The creator of the PR" + }, + "type": "object" + } + }, + "type": "object" + }, + "BitBucketCloudPRComment": { + "properties": { + "content": { + "$ref": "#/definitions/BitBucketCloudContent" }, - "closed": { - "description": "Is the PR closed?", + "created_on": { + "description": "When the comment was created, in ISO 8601 format", + "type": "string" + }, + "deleted": { "type": "boolean" }, - "createdDate": { + "id": { + "type": "number" + }, + "inline": { + "properties": { + "from": { + "type": "number" + }, + "path": { + "type": "string" + }, + "to": { + "type": [ + "null", + "number" + ] + } + }, + "type": "object" + }, + "links": { + "$ref": "#/definitions/BitBucketCloudLinks<\"html\"|\"self\">" + }, + "pullrequest": { + "properties": { + "id": { + "type": "number" + }, + "links": { + "$ref": "#/definitions/BitBucketCloudLinks<\"html\"|\"self\">" + }, + "title": { + "type": "string" + } + }, + "type": "object" + }, + "type": { + "type": "string" + }, + "updated_on": { + "description": "When the comment was updated, in ISO 8601 format", + "type": "string" + }, + "user": { + "$ref": "#/definitions/BitBucketCloudUser" + } + }, + "type": "object" + }, + "BitBucketCloudPRDSL": { + "properties": { + "author": { + "$ref": "#/definitions/BitBucketCloudUser", + "description": "The creator of the PR" + }, + "created_on": { "description": "Date PR created as number of milliseconds since the unix epoch", "type": "number" }, @@ -305,73 +341,36 @@ "description": "The text describing the PR", "type": "string" }, - "fromRef": { - "$ref": "#/definitions/BitBucketServerMergeRef", - "description": "The PR submitter's reference" + "destination": { + "$ref": "#/definitions/BitBucketCloudMergeRef", + "description": "The PR's destination" }, "id": { "description": "The PR's ID", "type": "number" }, "links": { - "description": "Misc links for hypermedia conformance", - "enum": [ - "self" - ], - "type": "string" - }, - "locked": { - "description": "Was this PR locked?", - "type": "boolean" - }, - "open": { - "description": "Is the PR open?", - "type": "boolean" + "$ref": "#/definitions/BitBucketCloudLinks<\"html\"|\"self\"|\"decline\"|\"commits\"|\"comments\"|\"merge\"|\"activity\"|\"diff\"|\"approve\"|\"statuses\">", + "description": "Misc links for hypermedia conformance" }, "participants": { "description": "People who have participated in the PR", "items": { - "allOf": [ - { - "$ref": "#/definitions/BitBucketServerPRParticipant" - }, - { - "properties": { - "role": { - "enum": [ - "PARTICIPANT" - ], - "type": "string" - } - }, - "type": "object" - } - ] + "$ref": "#/definitions/BitBucketCloudPRParticipant" }, "type": "array" }, "reviewers": { "description": "People requested as reviewers", "items": { - "allOf": [ - { - "$ref": "#/definitions/BitBucketServerPRParticipant" - }, - { - "properties": { - "role": { - "enum": [ - "REVIEWER" - ], - "type": "string" - } - }, - "type": "object" - } - ] + "$ref": "#/definitions/BitBucketCloudUser" }, "type": "array" }, + "source": { + "$ref": "#/definitions/BitBucketCloudMergeRef", + "description": "The PR's source, The repo Danger is running on" + }, "state": { "description": "The pull request's current status.", "enum": [ @@ -386,22 +385,14 @@ "description": "Title of the pull request.", "type": "string" }, - "toRef": { - "$ref": "#/definitions/BitBucketServerMergeRef", - "description": "The repo Danger is running on" - }, - "updatedDate": { + "updated_on": { "description": "Date PR updated as number of milliseconds since the unix epoch", "type": "number" - }, - "version": { - "description": "The API version", - "type": "number" } }, "type": "object" }, - "BitBucketServerPRParticipant": { + "BitBucketCloudPRParticipant": { "properties": { "approved": { "description": "Did they approve of the PR?", @@ -410,773 +401,7329 @@ "role": { "description": "How did they contribute", "enum": [ - "AUTHOR", "PARTICIPANT", "REVIEWER" ], "type": "string" }, - "status": { - "description": "Their review feedback", - "enum": [ - "APPROVED", - "NEEDS_WORK", - "UNAPPROVED" - ], + "user": { + "$ref": "#/definitions/BitBucketCloudUser" + } + }, + "type": "object" + }, + "BitBucketCloudRepo": { + "properties": { + "full_name": { "type": "string" }, - "user": { - "$ref": "#/definitions/BitBucketServerUser" + "name": { + "type": "string" + }, + "uuid": { + "type": "string" } }, "type": "object" }, - "BitBucketServerRepo": { - "description": "A BitBucket Server Repo", + "BitBucketCloudUser": { "properties": { - "forkable": { - "description": "Can someone fork this repo?", - "type": "boolean" + "account_id": { + "description": "The acount id of the commit author", + "type": "string" }, - "links": { - "$ref": "#/definitions/BitBucketServerLinks", - "description": "Links for the projects" + "display_name": { + "description": "The display name of the commit author", + "type": "string" }, - "name": { - "description": "The repo name", + "nickname": { + "description": "The nick name of the commit author", "type": "string" }, - "project": { - "description": "An abstraction for grouping repos", + "uuid": { + "description": "The uuid of the commit author", + "type": "string" + } + }, + "type": "object" + }, + "BitBucketServerCommit": { + "description": "A BitBucketServer specific implementation of a git commit.", + "properties": { + "author": { + "description": "The author of the commit, assumed to be the person who wrote the code.", "properties": { - "id": { - "description": "The project unique id", - "type": "number" - }, - "key": { - "description": "The project's human readable project key", + "displayName": { + "description": "The display name of the commit author", "type": "string" }, - "links": { - "description": "Hyperlinks for the project", - "enum": [ - "self" - ], + "emailAddress": { + "description": "The email of the commit author", "type": "string" }, "name": { - "description": "The name of the project", + "description": "The id of the commit author", + "type": "string" + } + }, + "type": "object" + }, + "authorTimestamp": { + "description": "The UNIX timestamp for when the commit was authored", + "type": "number" + }, + "committer": { + "description": "The author of the commit, assumed to be the person who committed/merged the code into a project.", + "properties": { + "displayName": { + "description": "The display name of the commit committer", "type": "string" }, - "public": { - "description": "Is the project publicly available", - "type": "boolean" + "emailAddress": { + "description": "The email of the commit committer", + "type": "string" }, - "type": { - "description": "The project's type", + "name": { + "description": "The id of the commit committer", "type": "string" } }, "type": "object" }, - "public": { - "description": "Is the repo public?", - "type": "boolean" + "committerTimestamp": { + "description": "When the commit was committed to the project", + "type": "number" }, - "scmId": { - "description": "The type of SCM tool, probably \"git\"", + "displayId": { + "description": "The shortened SHA for the commit", "type": "string" }, - "slug": { - "description": "The slug for the repo", + "id": { + "description": "The SHA for the commit", + "type": "string" + }, + "message": { + "description": "The commit's message", "type": "string" + }, + "parents": { + "description": "The commit's parents", + "items": { + "properties": { + "displayId": { + "description": "The simplified sha", + "type": "string" + }, + "id": { + "description": "The full SHA", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" } }, "type": "object" }, - "BitBucketServerUser": { - "description": "A BitBucketServer user account.", + "BitBucketServerJSONDSL": { "properties": { - "active": { - "description": "Is the account active", - "type": "boolean" - }, - "displayName": { - "description": "The name to use when referencing the user", - "type": "string" + "activities": { + "description": "The activities such as OPENING, CLOSING, MERGING or UPDATING a pull request", + "items": { + "$ref": "#/definitions/BitBucketServerPRActivity" + }, + "type": "array" }, - "emailAddress": { - "description": "The email for the user", - "type": "string" + "comments": { + "description": "The comments on the pull request", + "items": { + "$ref": "#/definitions/BitBucketServerPRActivity" + }, + "type": "array" }, - "id": { - "description": "The unique user ID", - "type": "number" + "commits": { + "description": "The commits associated with the pull request", + "items": { + "$ref": "#/definitions/BitBucketServerCommit" + }, + "type": "array" }, - "name": { - "description": "The name of the user", - "type": "string" + "issues": { + "description": "The related JIRA issues", + "items": { + "$ref": "#/definitions/JIRAIssue" + }, + "type": "array" }, - "slug": { - "description": "The user's slug for URLs", - "type": "string" + "metadata": { + "$ref": "#/definitions/RepoMetaData", + "description": "The pull request and repository metadata" }, - "type": { - "description": "The type of a user, \"NORMAL\" being a typical user3", - "enum": [ - "NORMAL", - "SERVICE" - ], - "type": "string" + "pr": { + "$ref": "#/definitions/BitBucketServerPRDSL", + "description": "The PR metadata" } }, "type": "object" }, - "CliArgs": { - "description": "Describes the possible arguments that\ncould be used when calling the CLI", + "BitBucketServerLinks": { + "enum": [ + "clone", + "self" + ], + "type": "string" + }, + "BitBucketServerMergeRef": { "properties": { - "base": { - "description": "The base reference used by danger PR (e.g. not master)", - "type": "string" - }, - "dangerfile": { - "description": "A custom path for the dangerfile (can also be a remote reference)", - "type": "string" - }, - "externalCiProvider": { - "description": "Used by danger-js o allow having a custom CI", + "displayId": { "type": "string" }, "id": { - "description": "So you can have many danger runs in one code review", "type": "string" }, - "textOnly": { - "description": "Use SDTOUT instead of posting to the code review side", + "latestCommit": { "type": "string" }, - "verbose": { - "description": "For debugging", - "type": "string" + "repository": { + "$ref": "#/definitions/BitBucketServerRepo" } }, "type": "object" }, - "DangerDSLJSONType": { - "description": "The root of the Danger JSON DSL.", + "BitBucketServerPRActivity": { "properties": { - "bitbucket_server": { - "$ref": "#/definitions/BitBucketServerJSONDSL", - "description": "The data only version of BitBucket Server DSL" + "action": { + "enum": [ + "COMMENTED", + "DECLINED", + "MERGED", + "OPENED", + "UPDATED" + ], + "type": "string" }, - "git": { - "$ref": "#/definitions/GitJSONDSL", - "description": "The data only version of Git DSL" + "comment": { + "$ref": "#/definitions/BitBucketServerPRComment" }, - "github": { - "$ref": "#/definitions/GitHubDSL", - "description": "The data only version of GitHub DSL" + "commentAction": { + "enum": [ + "ADDED", + "UPDATED" + ], + "type": "string" }, - "settings": { - "description": "Used in the Danger JSON DSL to pass metadata between\nprocesses. It will be undefined when used inside the Danger DSL", + "commentAnchor": { "properties": { - "cliArgs": { - "$ref": "#/definitions/CliArgs", - "description": "This is still a bit of a WIP, but this should\npass args/opts from the original CLI call through\nto the process." + "diffType": { + "enum": [ + "COMMIT", + "EFFECTIVE", + "RANGE", + "REQUIRED" + ], + "type": "string" }, - "github": { - "description": "Saves each client re-implementing logic to grab these vars\nfor their API clients", - "properties": { - "accessToken": { - "description": "API token for the GitHub client to use", - "type": "string" - }, - "additionalHeaders": { - "description": "Optional headers to add to a request" - }, - "baseURL": { - "description": "Optional URL for enterprise GitHub", - "type": "string" - } - }, - "type": "object" + "fileType": { + "enum": [ + "FROM", + "TO" + ], + "type": "string" + }, + "fromHash": { + "type": "string" + }, + "line": { + "type": "number" + }, + "lineType": { + "enum": [ + "ADDED", + "CONTEXT", + "REMOVED" + ], + "type": "string" + }, + "path": { + "type": "string" + }, + "srcPath": { + "type": "string" + }, + "toHash": { + "type": "string" } }, "type": "object" + }, + "createdDate": { + "type": "number" + }, + "id": { + "type": "number" + }, + "user": { + "$ref": "#/definitions/BitBucketServerUser" } }, "type": "object" }, - "GitCommit": { - "description": "A platform agnostic reference to a Git commit", + "BitBucketServerPRComment": { "properties": { "author": { - "$ref": "#/definitions/GitCommitAuthor", - "description": "Who wrote the commit" - }, - "committer": { - "$ref": "#/definitions/GitCommitAuthor", - "description": "Who deployed the commit" - }, - "message": { - "description": "The commit message", - "type": "string" + "$ref": "#/definitions/BitBucketServerUser" }, - "parents": { - "description": "SHAs for the commit's parents", + "comments": { "items": { - "type": "string" + "$ref": "#/definitions/BitBucketServerPRActivity" }, "type": "array" }, - "sha": { - "description": "The SHA for the commit", - "type": "string" + "createdDate": { + "type": "number" }, - "tree": { - "description": "Potential parent commits, and other assorted metadata" + "id": { + "type": "number" }, - "url": { - "description": "Link to the commit", - "type": "string" - } - }, - "type": "object" - }, - "GitCommitAuthor": { - "description": "An author of a commit", - "properties": { - "date": { - "description": "ISO6801 date string", - "type": "string" + "parent": { + "properties": { + "id": { + "type": "number" + } + }, + "type": "object" }, - "email": { - "description": "The authors email", - "type": "string" + "permittedOperations": { + "properties": { + "deletable": { + "type": "boolean" + }, + "editable": { + "type": "boolean" + } + }, + "type": "object" }, - "name": { - "description": "The display name for the author", + "text": { "type": "string" + }, + "updatedDate": { + "type": "number" + }, + "version": { + "type": "number" } }, "type": "object" }, - "GitHubAPIPR": { - "description": "Provides the current PR in an easily used way for params in `github.api` calls", - "properties": { - "number": { - "description": "The PR number", - "type": "number" - }, - "owner": { - "description": "The repo owner", - "type": "string" - }, - "repo": { - "description": "The repo name", - "type": "string" - } - }, - "type": "object" - }, - "GitHubCommit": { - "description": "A GitHub specific implementation of a git commit, it has GitHub user names instead of an email.", + "BitBucketServerPRDSL": { + "description": "An exact copy of the PR's reference JSON. This interface has type'd the majority\nof it for tooling's sake, but any extra metadata which BitBucket Server send\nwill still be inside the JS object.", "properties": { "author": { - "$ref": "#/definitions/GitHubUser", - "description": "The GitHub user who wrote the code" - }, - "commit": { - "$ref": "#/definitions/GitCommit", - "description": "The raw commit metadata" + "allOf": [ + { + "$ref": "#/definitions/BitBucketServerPRParticipant" + }, + { + "properties": { + "role": { + "enum": [ + "AUTHOR" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "description": "The creator of the PR" }, - "committer": { - "$ref": "#/definitions/GitHubUser", - "description": "The GitHub user who shipped the code" + "closed": { + "description": "Is the PR closed?", + "type": "boolean" }, - "parents": { - "description": "An array of parent commit shas", - "items": { - }, - "type": "array" + "createdDate": { + "description": "Date PR created as number of milliseconds since the unix epoch", + "type": "number" }, - "sha": { - "description": "The SHA for the commit", + "description": { + "description": "The text describing the PR", "type": "string" }, - "url": { - "description": "the url for the commit on GitHub", - "type": "string" - } - }, - "type": "object" - }, - "GitHubDSL": { - "description": "The GitHub metadata for your PR", - "properties": { - "api": { - "$ref": "#/definitions/Github", - "description": "An authenticated API so you can extend danger's behavior by using the [GitHub v3 API](https://developer.github.com/v3/).\n\nA set up instance of the \"github\" npm module. You can get the full [API here](https://octokit.github.io/node-github/)." + "fromRef": { + "$ref": "#/definitions/BitBucketServerMergeRef", + "description": "The PR submitter's reference" }, - "commits": { - "description": "The github commit metadata for a code review session", - "items": { - "$ref": "#/definitions/GitHubCommit" - }, - "type": "array" + "id": { + "description": "The PR's ID", + "type": "number" }, - "issue": { - "$ref": "#/definitions/GitHubIssue", - "description": "The issue metadata for a code review session" + "links": { + "description": "Misc links for hypermedia conformance", + "enum": [ + "self" + ], + "type": "string" }, - "pr": { - "$ref": "#/definitions/GitHubPRDSL", - "description": "The PR metadata for a code review session" + "locked": { + "description": "Was this PR locked?", + "type": "boolean" }, - "requested_reviewers": { - "description": "The people requested to review this PR", + "open": { + "description": "Is the PR open?", + "type": "boolean" + }, + "participants": { + "description": "People who have participated in the PR", "items": { - "$ref": "#/definitions/GitHubUser" + "allOf": [ + { + "$ref": "#/definitions/BitBucketServerPRParticipant" + }, + { + "properties": { + "role": { + "enum": [ + "PARTICIPANT" + ], + "type": "string" + } + }, + "type": "object" + } + ] }, "type": "array" }, - "reviews": { - "description": "The reviews left on this pull request", + "reviewers": { + "description": "People requested as reviewers", "items": { - "$ref": "#/definitions/GitHubReview" + "allOf": [ + { + "$ref": "#/definitions/BitBucketServerPRParticipant" + }, + { + "properties": { + "role": { + "enum": [ + "REVIEWER" + ], + "type": "string" + } + }, + "type": "object" + } + ] }, "type": "array" }, - "thisPR": { - "$ref": "#/definitions/GitHubAPIPR", - "description": "The PR metadata specifically formatted for using with the GitHub API client" + "state": { + "description": "The pull request's current status.", + "enum": [ + "DECLINED", + "MERGED", + "OPEN", + "SUPERSEDED" + ], + "type": "string" }, - "utils": { - "$ref": "#/definitions/GitHubUtilsDSL", - "description": "A scope for useful functions related to GitHub" - } - }, - "type": "object" - }, - "GitHubIssue": { - "description": "This is `danger.github.issue` It refers to the issue that makes up the Pull Request.\nGitHub treats all pull requests as a special type of issue. This DSL contains only parts of the issue that are\nnot found in the PR DSL, however it does contain the full JSON structure.\n\nA GitHub Issue", - "properties": { - "labels": { - "description": "The labels associated with this issue", - "items": { - "$ref": "#/definitions/GitHubIssueLabel" - }, - "type": "array" - } - }, - "type": "object" - }, - "GitHubIssueLabel": { - "properties": { - "color": { - "description": "The color associated with this label", + "title": { + "description": "Title of the pull request.", "type": "string" }, - "id": { - "description": "The identifying number of this label", - "type": "number" + "toRef": { + "$ref": "#/definitions/BitBucketServerMergeRef", + "description": "The repo Danger is running on" }, - "name": { - "description": "The name of the label", - "type": "string" + "updatedDate": { + "description": "Date PR updated as number of milliseconds since the unix epoch", + "type": "number" }, - "url": { - "description": "The URL that links to this label", - "type": "string" + "version": { + "description": "The API version", + "type": "number" } }, "type": "object" }, - "GitHubMergeRef": { + "BitBucketServerPRParticipant": { "properties": { - "label": { - "description": "The human display name for the merge reference, e.g. \"artsy:master\"", - "type": "string" + "approved": { + "description": "Did they approve of the PR?", + "type": "boolean" }, - "ref": { - "description": "The reference point for the merge, e.g. \"master\"", + "role": { + "description": "How did they contribute", + "enum": [ + "AUTHOR", + "PARTICIPANT", + "REVIEWER" + ], "type": "string" }, - "repo": { - "$ref": "#/definitions/GitHubRepo", - "description": "The repo from which the reference comes from" - }, - "sha": { - "description": "The reference point for the merge, e.g. \"704dc55988c6996f69b6873c2424be7d1de67bbe\"", + "status": { + "description": "Their review feedback", + "enum": [ + "APPROVED", + "NEEDS_WORK", + "UNAPPROVED" + ], "type": "string" }, "user": { - "$ref": "#/definitions/GitHubUser", - "description": "The user that owns the merge reference e.g. \"artsy\"" + "$ref": "#/definitions/BitBucketServerUser" } }, "type": "object" }, - "GitHubPRDSL": { - "description": "An exact copy of the PR's reference JSON. This interface has type'd the majority\nof it for tooling's sake, but any extra metadata which GitHub send will still be\ninside the JS object.", + "BitBucketServerRepo": { + "description": "A BitBucket Server Repo", "properties": { - "additions": { - "description": "The number of additional lines in the PR", - "type": "number" + "forkable": { + "description": "Can someone fork this repo?", + "type": "boolean" }, - "assignee": { - "$ref": "#/definitions/GitHubUser", - "description": "The User who is assigned the PR" + "links": { + "$ref": "#/definitions/BitBucketServerLinks", + "description": "Links for the projects" }, - "assignees": { - "description": "The Users who are assigned to the PR", - "items": { - "$ref": "#/definitions/GitHubUser" - }, - "type": "array" + "name": { + "description": "The repo name", + "type": "string" }, - "base": { - "$ref": "#/definitions/GitHubMergeRef", - "description": "Merge reference for _this_ repo." + "project": { + "description": "An abstraction for grouping repos", + "properties": { + "id": { + "description": "The project unique id", + "type": "number" + }, + "key": { + "description": "The project's human readable project key", + "type": "string" + }, + "links": { + "description": "Hyperlinks for the project", + "enum": [ + "self" + ], + "type": "string" + }, + "name": { + "description": "The name of the project", + "type": "string" + }, + "public": { + "description": "Is the project publicly available", + "type": "boolean" + }, + "type": { + "description": "The project's type", + "type": "string" + } + }, + "type": "object" }, - "body": { - "description": "The markdown body message of the PR", + "public": { + "description": "Is the repo public?", + "type": "boolean" + }, + "scmId": { + "description": "The type of SCM tool, probably \"git\"", "type": "string" }, - "changed_files": { - "description": "The number of changed files in the PR", - "type": "number" + "slug": { + "description": "The slug for the repo", + "type": "string" + } + }, + "type": "object" + }, + "BitBucketServerUser": { + "description": "A BitBucketServer user account.", + "properties": { + "active": { + "description": "Is the account active", + "type": "boolean" }, - "closed_at": { - "description": "optional ISO6801 Date string for when PR was closed", - "type": [ - "null", - "string" - ] + "displayName": { + "description": "The name to use when referencing the user", + "type": "string" }, - "comments": { - "description": "The number of comments on the PR", - "type": "number" + "emailAddress": { + "description": "The email for the user", + "type": "string" }, - "commits": { - "description": "The number of commits in the PR", + "id": { + "description": "The unique user ID", "type": "number" }, - "created_at": { - "description": "ISO6801 Date string for when PR was created", + "name": { + "description": "The name of the user", "type": "string" }, - "deletions": { - "description": "The number of deleted lines in the PR", - "type": "number" + "slug": { + "description": "The user's slug for URLs", + "type": "string" }, - "head": { - "$ref": "#/definitions/GitHubMergeRef", - "description": "Merge reference for the _other_ repo." + "type": { + "description": "The type of a user, \"NORMAL\" being a typical user3", + "enum": [ + "NORMAL", + "SERVICE" + ], + "type": "string" + } + }, + "type": "object" + }, + "CliArgs": { + "description": "Describes the possible arguments that\ncould be used when calling the CLI", + "properties": { + "base": { + "description": "The base reference used by danger PR (e.g. not master)", + "type": "string" }, - "html_url": { - "description": "The link back to this PR as user-facing", + "dangerfile": { + "description": "A custom path for the dangerfile (can also be a remote reference)", "type": "string" }, - "locked": { - "description": "Has the PR been locked to contributors only?", - "type": "boolean" + "externalCiProvider": { + "description": "Used by danger-js o allow having a custom CI", + "type": "string" }, - "merged": { - "description": "Has the PR been merged yet?", + "id": { + "description": "So you can have many danger runs in one code review", + "type": "string" + }, + "staging": { + "description": "Use staged changes", "type": "boolean" }, - "merged_at": { - "description": "Optional ISO6801 Date string for when PR was merged.\nDanger probably shouldn't be running in this state.", - "type": [ - "null", - "string" - ] + "textOnly": { + "description": "Use SDTOUT instead of posting to the code review side", + "type": "string" }, - "number": { - "description": "The UUID for the PR", - "type": "number" + "verbose": { + "description": "For debugging", + "type": "string" + } + }, + "type": "object" + }, + "DangerDSLJSONType": { + "description": "The root of the Danger JSON DSL.", + "properties": { + "bitbucket_cloud": { + "$ref": "#/definitions/BitBucketCloudJSONDSL", + "description": "The data only version of BitBucket Cloud DSL" }, - "review_comments": { - "description": "The number of review-specific comments on the PR", - "type": "number" + "bitbucket_server": { + "$ref": "#/definitions/BitBucketServerJSONDSL", + "description": "The data only version of BitBucket Server DSL" }, - "state": { - "description": "The state for the PR", - "enum": [ - "closed", - "locked", - "merged", - "open" - ], + "git": { + "$ref": "#/definitions/GitJSONDSL", + "description": "The data only version of Git DSL" + }, + "github": { + "$ref": "#/definitions/GitHubDSL", + "description": "The data only version of GitHub DSL" + }, + "gitlab": { + "$ref": "#/definitions/GitLabDSL", + "description": "The data only version of GitLab DSL" + }, + "settings": { + "description": "Used in the Danger JSON DSL to pass metadata between\nprocesses. It will be undefined when used inside the Danger DSL", + "properties": { + "cliArgs": { + "$ref": "#/definitions/CliArgs", + "description": "This is still a bit of a WIP, but this should\npass args/opts from the original CLI call through\nto the process." + }, + "github": { + "description": "Saves each client re-implementing logic to grab these vars\nfor their API clients", + "properties": { + "accessToken": { + "description": "API token for the GitHub client to use", + "type": "string" + }, + "additionalHeaders": { + "description": "Optional headers to add to a request" + }, + "baseURL": { + "description": "Optional URL for enterprise GitHub", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "GitCommit": { + "description": "A platform agnostic reference to a Git commit", + "properties": { + "author": { + "$ref": "#/definitions/GitCommitAuthor", + "description": "Who wrote the commit" + }, + "committer": { + "$ref": "#/definitions/GitCommitAuthor", + "description": "Who deployed the commit" + }, + "message": { + "description": "The commit message", "type": "string" }, - "title": { - "description": "The title of the PR", + "parents": { + "description": "SHAs for the commit's parents", + "items": { + "type": "string" + }, + "type": "array" + }, + "sha": { + "description": "The SHA for the commit", "type": "string" }, - "updated_at": { - "description": "ISO6801 Date string for when PR was updated", + "tree": { + "description": "Potential parent commits, and other assorted metadata" + }, + "url": { + "description": "Link to the commit", + "type": "string" + } + }, + "type": "object" + }, + "GitCommitAuthor": { + "description": "An author of a commit", + "properties": { + "date": { + "description": "ISO6801 date string", "type": "string" }, - "user": { - "$ref": "#/definitions/GitHubUser", - "description": "The User who submitted the PR" + "email": { + "description": "The authors email", + "type": "string" + }, + "name": { + "description": "The display name for the author", + "type": "string" + } + }, + "type": "object" + }, + "GitHubAPIPR": { + "description": "Provides the current PR in an easily used way for params in `github.api` calls", + "properties": { + "number": { + "description": "The PR number", + "type": "number" + }, + "owner": { + "description": "The repo owner", + "type": "string" + }, + "repo": { + "description": "The repo name", + "type": "string" + } + }, + "type": "object" + }, + "GitHubCommit": { + "description": "A GitHub specific implementation of a git commit, it has GitHub user names instead of an email.", + "properties": { + "author": { + "$ref": "#/definitions/GitHubUser", + "description": "The GitHub user who wrote the code" + }, + "commit": { + "$ref": "#/definitions/GitCommit", + "description": "The raw commit metadata" + }, + "committer": { + "$ref": "#/definitions/GitHubUser", + "description": "The GitHub user who shipped the code" + }, + "parents": { + "description": "An array of parent commit shas", + "items": { + }, + "type": "array" + }, + "sha": { + "description": "The SHA for the commit", + "type": "string" + }, + "url": { + "description": "the url for the commit on GitHub", + "type": "string" + } + }, + "type": "object" + }, + "GitHubDSL": { + "description": "The GitHub metadata for your PR", + "properties": { + "api": { + "$ref": "#/definitions/Octokit", + "description": "An authenticated API so you can extend danger's behavior by using the [GitHub v3 API](https://developer.github.com/v3/).\n\nA set up instance of the \"github\" npm module. You can get the full [API here](https://octokit.github.io/node-github/)." + }, + "commits": { + "description": "The github commit metadata for a code review session", + "items": { + "$ref": "#/definitions/GitHubCommit" + }, + "type": "array" + }, + "issue": { + "$ref": "#/definitions/GitHubIssue", + "description": "The issue metadata for a code review session" + }, + "pr": { + "$ref": "#/definitions/GitHubPRDSL", + "description": "The PR metadata for a code review session" + }, + "requested_reviewers": { + "$ref": "#/definitions/GitHubReviewers", + "description": "The people/teams requested to review this PR" + }, + "reviews": { + "description": "The reviews left on this pull request", + "items": { + "$ref": "#/definitions/GitHubReview" + }, + "type": "array" + }, + "thisPR": { + "$ref": "#/definitions/GitHubAPIPR", + "description": "The PR metadata specifically formatted for using with the GitHub API client" + }, + "utils": { + "$ref": "#/definitions/GitHubUtilsDSL", + "description": "A scope for useful functions related to GitHub" + } + }, + "type": "object" + }, + "GitHubIssue": { + "description": "This is `danger.github.issue` It refers to the issue that makes up the Pull Request.\nGitHub treats all pull requests as a special type of issue. This DSL contains only parts of the issue that are\nnot found in the PR DSL, however it does contain the full JSON structure.\n\nA GitHub Issue", + "properties": { + "labels": { + "description": "The labels associated with this issue", + "items": { + "$ref": "#/definitions/GitHubIssueLabel" + }, + "type": "array" + } + }, + "type": "object" + }, + "GitHubIssueLabel": { + "properties": { + "color": { + "description": "The color associated with this label", + "type": "string" + }, + "id": { + "description": "The identifying number of this label", + "type": "number" + }, + "name": { + "description": "The name of the label", + "type": "string" + }, + "url": { + "description": "The URL that links to this label", + "type": "string" + } + }, + "type": "object" + }, + "GitHubMergeRef": { + "properties": { + "label": { + "description": "The human display name for the merge reference, e.g. \"artsy:master\"", + "type": "string" + }, + "ref": { + "description": "The reference point for the merge, e.g. \"master\"", + "type": "string" + }, + "repo": { + "$ref": "#/definitions/GitHubRepo", + "description": "The repo from whch the reference comes from" + }, + "sha": { + "description": "The reference point for the merge, e.g. \"704dc55988c6996f69b6873c2424be7d1de67bbe\"", + "type": "string" + }, + "user": { + "$ref": "#/definitions/GitHubUser", + "description": "The user that owns the merge reference e.g. \"artsy\"" + } + }, + "type": "object" + }, + "GitHubPRDSL": { + "description": "An exact copy of the PR's reference JSON. This interface has type'd the majority\nof it for tooling's sake, but any extra metadata which GitHub send will still be\ninside the JS object.", + "properties": { + "additions": { + "description": "The number of additional lines in the PR", + "type": "number" + }, + "assignee": { + "$ref": "#/definitions/GitHubUser", + "description": "The User who is assigned the PR" + }, + "assignees": { + "description": "The Users who are assigned to the PR", + "items": { + "$ref": "#/definitions/GitHubUser" + }, + "type": "array" + }, + "author_association": { + "description": "How does the PR author relate to this repo/org?", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MEMBER", + "NONE", + "OWNER" + ], + "type": "string" + }, + "base": { + "$ref": "#/definitions/GitHubMergeRef", + "description": "Merge reference for _this_ repo." + }, + "body": { + "description": "The markdown body message of the PR", + "type": "string" + }, + "changed_files": { + "description": "The number of changed files in the PR", + "type": "number" + }, + "closed_at": { + "description": "optional ISO6801 Date string for when PR was closed", + "type": [ + "null", + "string" + ] + }, + "comments": { + "description": "The number of comments on the PR", + "type": "number" + }, + "commits": { + "description": "The number of commits in the PR", + "type": "number" + }, + "created_at": { + "description": "ISO6801 Date string for when PR was created", + "type": "string" + }, + "deletions": { + "description": "The number of deleted lines in the PR", + "type": "number" + }, + "head": { + "$ref": "#/definitions/GitHubMergeRef", + "description": "Merge reference for the _other_ repo." + }, + "html_url": { + "description": "The link back to this PR as user-facing", + "type": "string" + }, + "locked": { + "description": "Has the PR been locked to contributors only?", + "type": "boolean" + }, + "merged": { + "description": "Has the PR been merged yet?", + "type": "boolean" + }, + "merged_at": { + "description": "Optional ISO6801 Date string for when PR was merged.\nDanger probably shouldn't be running in this state.", + "type": [ + "null", + "string" + ] + }, + "number": { + "description": "The UUID for the PR", + "type": "number" + }, + "review_comments": { + "description": "The number of review-specific comments on the PR", + "type": "number" + }, + "state": { + "description": "The state for the PR", + "enum": [ + "closed", + "locked", + "merged", + "open" + ], + "type": "string" + }, + "title": { + "description": "The title of the PR", + "type": "string" + }, + "updated_at": { + "description": "ISO6801 Date string for when PR was updated", + "type": "string" + }, + "user": { + "$ref": "#/definitions/GitHubUser", + "description": "The User who submitted the PR" + } + }, + "type": "object" + }, + "GitHubRepo": { + "description": "A GitHub Repo", + "properties": { + "assignee": { + "$ref": "#/definitions/GitHubUser", + "description": "Is someone assigned to this PR?" + }, + "assignees": { + "description": "Are there people assigned to this PR?", + "items": { + "$ref": "#/definitions/GitHubUser" + }, + "type": "array" + }, + "description": { + "description": "The textual description of the repo", + "type": "string" + }, + "fork": { + "description": "Is the repo a fork?", + "type": "boolean" + }, + "full_name": { + "description": "The full name of the owner + repo, e.g. \"Danger/Danger-JS\"", + "type": "string" + }, + "html_url": { + "description": "The root web URL for the repo, e.g. https://github.com/artsy/emission", + "type": "string" + }, + "id": { + "description": "Generic UUID", + "type": "number" + }, + "name": { + "description": "The name of the repo, e.g. \"Danger-JS\"", + "type": "string" + }, + "owner": { + "$ref": "#/definitions/GitHubUser", + "description": "The owner of the repo" + }, + "private": { + "description": "Is the repo publicly accessible?", + "type": "boolean" + } + }, + "type": "object" + }, + "GitHubReview": { + "description": "GitHubReview\nWhile a review is pending, it will only have a user. Once a review is complete, the rest of\nthe review attributes will be present", + "properties": { + "body": { + "description": "If there is a review, the body of the review", + "type": "string" + }, + "commit_id": { + "description": "If there is a review, the commit ID this review was made on", + "type": "string" + }, + "id": { + "description": "If there is a review, this provides the ID for it", + "type": "number" + }, + "state": { + "description": "The state of the review\nAPPROVED, REQUEST_CHANGES, COMMENT or PENDING", + "enum": [ + "APPROVED", + "COMMENT", + "PENDING", + "REQUEST_CHANGES" + ], + "type": "string" + }, + "user": { + "$ref": "#/definitions/GitHubUser", + "description": "The user requested to review, or the user who has completed the review" + } + }, + "type": "object" + }, + "GitHubReviewers": { + "properties": { + "teams": { + "description": "Teams that have been requested", + "items": { + }, + "type": "array" + }, + "users": { + "description": "Users that have been requested", + "items": { + "$ref": "#/definitions/GitHubUser" + }, + "type": "array" + } + }, + "type": "object" + }, + "GitHubUser": { + "description": "A GitHub user account.", + "properties": { + "avatar_url": { + "description": "The url for a users's image", + "type": "string" + }, + "href": { + "description": "The href for a users's page", + "type": "string" + }, + "id": { + "description": "Generic UUID", + "type": "number" + }, + "login": { + "description": "The handle for the user/org", + "type": "string" + }, + "type": { + "description": "Whether the user is an org, or a user", + "enum": [ + "Bot", + "Organization", + "User" + ], + "type": "string" + } + }, + "type": "object" + }, + "GitHubUtilsDSL": { + "description": "Useful functions for GitHub related work", + "properties": { + "createOrAddLabel": { + "description": "An API for creating, or setting a label to an issue. Usable from Peril\nby adding an additional param for settings about a repo.", + "type": "object" + }, + "createOrUpdatePR": { + "type": "object" + }, + "createUpdatedIssueWithID": { + "description": "An API for creating, updating and closing an issue. Basically\nthis is really useful for reporting back via a separate\nissue that you may want to keep up to date at all times.", + "type": "object" + } + }, + "type": "object" + }, + "GitJSONDSL": { + "description": "The Git Related Metadata which is available inside the Danger DSL JSON", + "properties": { + "commits": { + "description": "The Git commit metadata", + "items": { + "$ref": "#/definitions/GitCommit" + }, + "type": "array" + }, + "created_files": { + "description": "Newly created filepaths relative to the git root", + "items": { + "type": "string" + }, + "type": "array" + }, + "deleted_files": { + "description": "Removed filepaths relative to the git root", + "items": { + "type": "string" + }, + "type": "array" + }, + "modified_files": { + "description": "Filepaths with changes relative to the git root", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GitLabDSL": { + "properties": { + "commits": { + "items": { + "$ref": "#/definitions/GitLabMRCommit" + }, + "type": "array" + }, + "metadata": { + "$ref": "#/definitions/RepoMetaData" + }, + "mr": { + "$ref": "#/definitions/GitLabMR" + }, + "utils": { + "type": "object" + } + }, + "type": "object" + }, + "GitLabMR": { + "properties": { + "allow_collaboration": { + "type": "boolean" + }, + "allow_maintainer_to_push": { + "type": "boolean" + }, + "approvals_before_merge": { + "type": "null" + }, + "assignee": { + "$ref": "#/definitions/GitLabUser" + }, + "author": { + "$ref": "#/definitions/GitLabUser" + }, + "changes_count": { + "type": "string" + }, + "closed_at": { + "type": [ + "null", + "string" + ] + }, + "closed_by": { + "anyOf": [ + { + "$ref": "#/definitions/GitLabUser" + }, + { + "type": "null" + } + ] + }, + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "diff_refs": { + "properties": { + "base_sha": { + "type": "string" + }, + "head_sha": { + "type": "string" + }, + "start_sha": { + "type": "string" + } + }, + "type": "object" + }, + "discussion_locked": { + "type": "null" + }, + "diverged_commits_count": { + "type": "number" + }, + "downvotes": { + "type": "number" + }, + "first_deployed_to_production_at": { + "type": [ + "null", + "string" + ] + }, + "force_remove_source_branch": { + "type": "boolean" + }, + "id": { + "type": "number" + }, + "iid": { + "type": "number" + }, + "labels": { + "items": { + "type": "string" + }, + "type": "array" + }, + "latest_build_finished_at": { + "type": "string" + }, + "latest_build_started_at": { + "type": "string" + }, + "merge_commit_sha": { + "type": [ + "null", + "string" + ] + }, + "merge_error": { + "type": "null" + }, + "merge_status": { + "enum": [ + "can_be_merged" + ], + "type": "string" + }, + "merge_when_pipeline_succeeds": { + "type": "boolean" + }, + "merged_at": { + "type": "string" + }, + "merged_by": { + "$ref": "#/definitions/GitLabUser" + }, + "milestone": { + "properties": { + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "due_date": { + "type": "string" + }, + "id": { + "type": "number" + }, + "iid": { + "type": "number" + }, + "project_id": { + "type": "number" + }, + "start_date": { + "type": "string" + }, + "state": { + "enum": [ + "active", + "closed" + ], + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "web_url": { + "type": "string" + } + }, + "type": "object" + }, + "pipeline": { + "properties": { + "id": { + "type": "number" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "status": { + "enum": [ + "canceled", + "failed", + "pending", + "running", + "skipped", + "success" + ], + "type": "string" + }, + "web_url": { + "type": "string" + } + }, + "type": "object" + }, + "project_id": { + "type": "number" + }, + "rebase_in_progress": { + "type": "boolean" + }, + "sha": { + "type": "string" + }, + "should_remove_source_branch": { + "type": "boolean" + }, + "source_branch": { + "type": "string" + }, + "source_project_id": { + "type": "number" + }, + "squash": { + "type": "boolean" + }, + "state": { + "enum": [ + "closed", + "locked", + "merged", + "open" + ], + "type": "string" + }, + "subscribed": { + "type": "boolean" + }, + "target_branch": { + "type": "string" + }, + "target_project_id": { + "type": "number" + }, + "time_stats": { + "properties": { + "human_time_estimate": { + "type": [ + "null", + "number" + ] + }, + "human_total_time_spent": { + "type": [ + "null", + "number" + ] + }, + "time_estimate": { + "type": "number" + }, + "total_time_spent": { + "type": "number" + } + }, + "type": "object" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "upvotes": { + "type": "number" + }, + "user": { + "properties": { + "can_merge": { + "type": "boolean" + } + }, + "type": "object" + }, + "user_notes_count": { + "type": "number" + }, + "web_url": { + "type": "string" + }, + "work_in_progress": { + "type": "boolean" + } + }, + "type": "object" + }, + "GitLabMRCommit": { + "properties": { + "author_email": { + "type": "string" + }, + "author_name": { + "type": "string" + }, + "authored_date": { + "type": "string" + }, + "committed_date": { + "type": "string" + }, + "committer_email": { + "type": "string" + }, + "committer_name": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "parent_ids": { + "items": { + "type": "string" + }, + "type": "array" + }, + "short_id": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "type": "object" + }, + "GitLabUser": { + "properties": { + "avatar_url": { + "type": [ + "null", + "string" + ] + }, + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "state": { + "enum": [ + "active", + "blocked" + ], + "type": "string" + }, + "username": { + "type": "string" + }, + "web_url": { + "type": "string" + } + }, + "type": "object" + }, + "JIRAIssue": { + "description": "This is `danger.bitbucket_server.issues` It refers to the issues that are linked to the Pull Request.", + "properties": { + "key": { + "description": "The unique key for the issue e.g. JRA-11", + "type": "string" + }, + "url": { + "description": "The user-facing URL for that issue", + "type": "string" + } + }, + "type": "object" + }, + "Octokit": { + "properties": { + "actions": { + "properties": { + "cancelWorkflowRun": { + "description": "Cancels a workflow run using its `id`. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createOrUpdateSecretForRepo": { + "description": "Creates or updates a secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.\n\nEncrypt your secret using the [tweetsodium](https://github.com/mastahyeti/tweetsodium) library.\n\n\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createRegistrationToken": { + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.\n\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createRemoveToken": { + "description": "Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.\n\nRemove your self-hosted runner from a repository, replacing TOKEN with the remove token provided by this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteArtifact": { + "description": "Deletes an artifact for a workflow run. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteSecretFromRepo": { + "description": "Deletes a secret in a repository using the secret name. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "downloadArtifact": { + "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.\n\nCall this endpoint using the `-v` flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the `-o` flag.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getArtifact": { + "description": "Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getPublicKey": { + "description": "Gets your public key, which you must store. You need your public key to use other secrets endpoints. Use the returned `key` to encrypt your secrets. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getSecret": { + "description": "Gets a single secret without revealing its encrypted value. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getSelfHostedRunner": { + "description": "Gets a specific self-hosted runner. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getWorkflow": { + "description": "Gets a specific workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yml`. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getWorkflowJob": { + "description": "Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getWorkflowRun": { + "description": "Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listDownloadsForSelfHostedRunnerApplication": { + "description": "Lists binaries for the self-hosted runner application that you can download and run. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listJobsForWorkflowRun": { + "description": "Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listRepoWorkflowRuns": { + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters).\n\nAnyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listRepoWorkflows": { + "description": "Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listSecretsForRepo": { + "description": "Lists all secrets available in a repository without revealing their encrypted values. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listSelfHostedRunnersForRepo": { + "description": "Lists all self-hosted runners for a repository. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listWorkflowJobLogs": { + "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.\n\nCall this endpoint using the `-v` flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the `-o` flag.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listWorkflowRunArtifacts": { + "description": "Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listWorkflowRunLogs": { + "description": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.\n\nCall this endpoint using the `-v` flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the `-o` flag.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listWorkflowRuns": { + "description": "List all workflow runs for a workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters).\n\nAnyone with read access to the repository can use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "reRunWorkflow": { + "description": "Re-runs your workflow run using its `id`. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeSelfHostedRunner": { + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "activity": { + "properties": { + "checkStarringRepo": { + "description": "Requires for the user to be authenticated.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "checkWatchingRepoLegacy": { + "description": "Requires for the user to be authenticated.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteRepoSubscription": { + "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://developer.github.com/v3/activity/watching/#set-a-repository-subscription).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteThreadSubscription": { + "description": "Mutes all future notifications for a conversation until you comment on the thread or get **@mention**ed.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getRepoSubscription": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getThread": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getThreadSubscription": { + "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://developer.github.com/v3/activity/watching/#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listEventsForOrg": { + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listEventsForUser": { + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listFeeds": { + "description": "GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub global public timeline\n* **User**: The public timeline for any user, using [URI template](https://developer.github.com/v3/#hypermedia)\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://developer.github.com/v3/#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listNotifications": { + "description": "List all notifications for the current user, sorted by most recently updated.\n\nThe following example uses the `since` parameter to list notifications that have been updated after the specified time.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listNotificationsForRepo": { + "description": "List all notifications for the current user.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPublicEvents": { + "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPublicEventsForOrg": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPublicEventsForRepoNetwork": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPublicEventsForUser": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listReceivedEventsForUser": { + "description": "These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listReceivedPublicEventsForUser": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listRepoEvents": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listReposStarredByAuthenticatedUser": { + "description": "You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listReposStarredByUser": { + "description": "You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listReposWatchedByUser": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listStargazersForRepo": { + "description": "You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listWatchedReposForAuthenticatedUser": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listWatchersForRepo": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "markAsRead": { + "description": "Marks a notification as \"read\" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List your notifications](https://developer.github.com/v3/activity/notifications/#list-your-notifications) endpoint and pass the query parameter `all=false`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "markNotificationsAsReadForRepo": { + "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List your notifications in a repository](https://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository) endpoint and pass the query parameter `all=false`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "markThreadAsRead": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "setRepoSubscription": { + "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://developer.github.com/v3/activity/watching/#delete-a-repository-subscription) completely.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "setThreadSubscription": { + "description": "This lets you subscribe or unsubscribe from a conversation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "starRepo": { + "description": "Requires for the user to be authenticated.\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "stopWatchingRepoLegacy": { + "description": "Requires for the user to be authenticated.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "unstarRepo": { + "description": "Requires for the user to be authenticated.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "watchRepoLegacy": { + "description": "Requires the user to be authenticated.\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "apps": { + "properties": { + "addRepoToInstallation": { + "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization)) or [Basic Authentication](https://developer.github.com/v3/auth/#basic-authentication) to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "checkAccountIsAssociatedWithAny": { + "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "checkAccountIsAssociatedWithAnyStubbed": { + "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "checkAuthorization": { + "description": "**Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "checkToken": { + "description": "OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createContentAttachment": { + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://developer.github.com/v3/activity/events/types/#contentreferenceevent) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://developer.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.\n\nThis example creates a content attachment for the domain `https://errors.ai/`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createFromManifest": { + "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://developer.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createInstallationToken": { + "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.\n\nYou must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThis example grants the token \"Read and write\" permission to `issues` and \"Read\" permission to `contents`, and restricts the token's access to the repository with an `id` of 1296269.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteAuthorization": { + "description": "OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteInstallation": { + "description": "Uninstalls a GitHub App on a user, organization, or business account.\n\nYou must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteToken": { + "description": "OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "findOrgInstallation": { + "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "findRepoInstallation": { + "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "findUserInstallation": { + "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getAuthenticated": { + "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations](https://developer.github.com/v3/apps/#list-installations)\" endpoint.\n\nYou must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getBySlug": { + "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).\n\nIf the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getInstallation": { + "description": "You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getOrgInstallation": { + "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getRepoInstallation": { + "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getUserInstallation": { + "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listAccountsUserOrOrgOnPlan": { + "description": "Returns any accounts associated with a plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listAccountsUserOrOrgOnPlanStubbed": { + "description": "Returns any accounts associated with a plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listInstallationReposForAuthenticatedUser": { + "description": "List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou must use a [user-to-server OAuth access token](https://developer.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe access the user has to each repository is included in the hash under the `permissions` key.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listInstallations": { + "description": "You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThe permissions the installation has are included under the `permissions` key.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listInstallationsForAuthenticatedUser": { + "description": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nYou must use a [user-to-server OAuth access token](https://developer.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listMarketplacePurchasesForAuthenticatedUser": { + "description": "Returns only active subscriptions. You must use a [user-to-server OAuth access token](https://developer.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listMarketplacePurchasesForAuthenticatedUserStubbed": { + "description": "Returns only active subscriptions. You must use a [user-to-server OAuth access token](https://developer.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPlans": { + "description": "GitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPlansStubbed": { + "description": "GitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listRepos": { + "description": "List repositories that an installation can access.\n\nYou must use an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeRepoFromInstallation": { + "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization)) or [Basic Authentication](https://developer.github.com/v3/auth/#basic-authentication) to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "resetAuthorization": { + "description": "**Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "resetToken": { + "description": "OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "revokeAuthorizationForApplication": { + "description": "**Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "revokeGrantForApplication": { + "description": "**Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under \"Authorized OAuth Apps\" on GitHub](https://github.com/settings/applications#authorized).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "revokeInstallationToken": { + "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create a new installation token](https://developer.github.com/v3/apps/#create-a-new-installation-token)\" endpoint.\n\nYou must use an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "checks": { + "properties": { + "create": { + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createSuite": { + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nBy default, check suites are automatically created when you create a [check run](https://developer.github.com/v3/checks/runs/). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Set preferences for check suites on a repository](https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository)\". Your GitHub App must have the `checks:write` permission to create check suites.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "get": { + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nGets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getSuite": { + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listAnnotations": { + "description": "Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForRef": { + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForSuite": { + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listSuitesForRef": { + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "rerequestSuite": { + "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://developer.github.com/v3/activity/events/types/#checksuiteevent) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "setSuitesPreferences": { + "description": "Changes the default automatic flow when creating check suites. By default, the CheckSuiteEvent is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://developer.github.com/v3/checks/suites/#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "update": { + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "codesOfConduct": { + "properties": { + "getConductCode": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getForRepo": { + "description": "This method returns the contents of the repository's code of conduct file, if one is detected.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listConductCodes": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "emojis": { + "properties": { + "get": { + "description": "Lists all the emojis available to use on GitHub.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "gists": { + "properties": { + "checkIsStarred": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "create": { + "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createComment": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "delete": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteComment": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "fork": { + "description": "**Note**: This was previously `/gists/:gist_id/fork`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "get": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getComment": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getRevision": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "list": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listComments": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listCommits": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForks": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPublic": { + "description": "List all public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://developer.github.com/v3/#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPublicForUser": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listStarred": { + "description": "List the authenticated user's starred gists:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "star": { + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "unstar": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "update": { + "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateComment": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "git": { + "properties": { + "createBlob": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createCommit": { + "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\nIn this example, the payload of the signature would be:\n\n\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createRef": { + "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createTag": { + "description": "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](https://developer.github.com/v3/git/refs/#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://developer.github.com/v3/git/refs/#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createTree": { + "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://developer.github.com/v3/git/commits/#create-a-commit)\" and \"[Update a reference](https://developer.github.com/v3/git/refs/#update-a-reference).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteRef": { + "description": "```\n * DELETE /repos/octocat/Hello-World/git/refs/heads/feature-a\n * ```\n\n```\n * DELETE /repos/octocat/Hello-World/git/refs/tags/v1.0\n * ```", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getBlob": { + "description": "The `content` in the response will always be Base64 encoded.\n\n_Note_: This API supports blobs up to 100 megabytes in size.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getCommit": { + "description": "Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getRef": { + "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)\".\n\nTo get the reference for a branch named `skunkworkz/featureA`, the endpoint route is:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getTag": { + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getTree": { + "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listMatchingRefs": { + "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n**Note:** You need to explicitly [request a pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listRefs": { + "description": "Returns an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. If there are no references to list, a `404` is returned.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateRef": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "gitignore": { + "properties": { + "getTemplate": { + "description": "The API also allows fetching the source of a single template.\n\nUse the raw [media type](https://developer.github.com/v3/media/) to get the raw contents.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listTemplates": { + "description": "List all templates available to pass as an option when [creating a repository](https://developer.github.com/v3/repos/#create).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "hook": { + "type": "object" + }, + "interactions": { + "properties": { + "addOrUpdateRestrictionsForOrg": { + "description": "Temporarily restricts interactions to certain GitHub users in any public repository in the given organization. You must be an organization owner to set these restrictions.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addOrUpdateRestrictionsForRepo": { + "description": "Temporarily restricts interactions to certain GitHub users within the given repository. You must have owner or admin access to set restrictions.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getRestrictionsForOrg": { + "description": "Shows which group of GitHub users can interact with this organization and when the restriction expires. If there are no restrictions, you will see an empty response.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getRestrictionsForRepo": { + "description": "Shows which group of GitHub users can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeRestrictionsForOrg": { + "description": "Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeRestrictionsForRepo": { + "description": "Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "issues": { + "properties": { + "addAssignees": { + "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.\n\nThis example adds two assignees to the existing `octocat` assignee.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addLabels": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "checkAssignee": { + "description": "Checks if a user has permission to be assigned to an issue in this repository.\n\nIf the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.\n\nOtherwise a `404` status code is returned.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "create": { + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createComment": { + "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createLabel": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createMilestone": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteComment": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteLabel": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteMilestone": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "get": { + "description": "The API returns a [`301 Moved Permanently` status](https://developer.github.com/v3/#http-redirects) if the issue was [transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe to the [`issues`](https://developer.github.com/v3/activity/events/types/#issuesevent) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)\" endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getComment": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getEvent": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getLabel": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getMilestone": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "list": { + "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)\" endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listAssignees": { + "description": "Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listComments": { + "description": "Issue Comments are ordered by ascending ID.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listCommentsForRepo": { + "description": "By default, Issue Comments are ordered by ascending ID.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listEvents": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listEventsForRepo": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listEventsForTimeline": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForAuthenticatedUser": { + "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)\" endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForOrg": { + "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)\" endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForRepo": { + "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)\" endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listLabelsForMilestone": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listLabelsForRepo": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listLabelsOnIssue": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listMilestonesForRepo": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "lock": { + "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeAssignees": { + "description": "Removes one or more assignees from an issue.\n\nThis example removes two of three assignees, leaving the `octocat` assignee.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeLabel": { + "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeLabels": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "replaceLabels": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "unlock": { + "description": "Users with push access can unlock an issue's conversation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "update": { + "description": "Issue owners and users with push access can edit an issue.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateComment": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateLabel": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateMilestone": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "licenses": { + "properties": { + "get": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getForRepo": { + "description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [the repository contents API](https://developer.github.com/v3/repos/contents/#get-contents), this method also supports [custom media types](https://developer.github.com/v3/repos/contents/#custom-media-types) for retrieving the raw license content or rendered license HTML.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "list": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listCommonlyUsed": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "log": { + "$ref": "#/definitions/Octokit.Log" + }, + "markdown": { + "properties": { + "render": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "renderRaw": { + "description": "You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "get": { + "description": "This endpoint provides a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "migrations": { + "properties": { + "cancelImport": { + "description": "Stop an import for a repository.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteArchiveForAuthenticatedUser": { + "description": "Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://developer.github.com/v3/migrations/users/#list-user-migrations) and [Get the status of a user migration](https://developer.github.com/v3/migrations/users/#get-the-status-of-a-user-migration) endpoints, will continue to be available even after an archive is deleted.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteArchiveForOrg": { + "description": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "downloadArchiveForOrg": { + "description": "Fetches the URL to a migration archive.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getArchiveForAuthenticatedUser": { + "description": "Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:\n\n* attachments\n* bases\n* commit\\_comments\n* issue\\_comments\n* issue\\_events\n* issues\n* milestones\n* organizations\n* projects\n* protected\\_branches\n* pull\\_request\\_reviews\n* pull\\_requests\n* releases\n* repositories\n* review\\_comments\n* schema\n* users\n\nThe archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getArchiveForOrg": { + "description": "Fetches the URL to a migration archive.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getCommitAuthors": { + "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis API method and the \"Map a commit author\" method allow you to provide correct Git author information.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getImportProgress": { + "description": "View the progress of an import.\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://developer.github.com/v3/migrations/source_imports/#cancel-an-import) and [retry](https://developer.github.com/v3/migrations/source_imports/#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getLargeFiles": { + "description": "List files larger than 100MB found during the import", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getStatusForAuthenticatedUser": { + "description": "Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:\n\n* `pending` - the migration hasn't started yet.\n* `exporting` - the migration is in progress.\n* `exported` - the migration finished successfully.\n* `failed` - the migration failed.\n\nOnce the migration has been `exported` you can [download the migration archive](https://developer.github.com/v3/migrations/users/#download-a-user-migration-archive).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getStatusForOrg": { + "description": "Fetches the status of a migration.\n\nThe `state` of a migration can be one of the following values:\n\n* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForAuthenticatedUser": { + "description": "Lists all migrations a user has started.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForOrg": { + "description": "Lists the most recent migrations.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listReposForOrg": { + "description": "List all the repositories for this organization migration.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listReposForUser": { + "description": "Lists all the repositories for this user migration.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "mapCommitAuthor": { + "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "setLfsPreference": { + "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://help.github.com/articles/versioning-large-files/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "startForAuthenticatedUser": { + "description": "Initiates the generation of a user migration archive.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "startForOrg": { + "description": "Initiates the generation of a migration archive.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "startImport": { + "description": "Start a source import to a GitHub repository using GitHub Importer.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "unlockRepoForAuthenticatedUser": { + "description": "Unlocks a repository. You can lock repositories when you [start a user migration](https://developer.github.com/v3/migrations/users/#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://developer.github.com/v3/repos/#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "unlockRepoForOrg": { + "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://developer.github.com/v3/repos/#delete-a-repository) when the migration is complete and you no longer need the source data.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateImport": { + "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API request. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. You can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\nThe following example demonstrates the workflow for updating an import with \"project1\" as the project choice. Given a `project_choices` array like such:\n\nTo restart an import, no parameters are provided in the update request.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "oauthAuthorizations": { + "properties": { + "checkAuthorization": { + "description": "**Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createAuthorization": { + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\n**Warning:** Apps must use the [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://help.github.com/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be whitelisted. Read more about whitelisting tokens in [the GitHub Help documentation](https://help.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteAuthorization": { + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteGrant": { + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getAuthorization": { + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getGrant": { + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getOrCreateAuthorizationForApp": { + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\n**Warning:** Apps must use the [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication).\"\n\n**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getOrCreateAuthorizationForAppAndFingerprint": { + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\n**Warning:** Apps must use the [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getOrCreateAuthorizationForAppFingerprint": { + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\n**Warning:** Apps must use the [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listAuthorizations": { + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listGrants": { + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `[\"repo\", \"user\"]`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "resetAuthorization": { + "description": "**Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "revokeAuthorizationForApplication": { + "description": "**Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "revokeGrantForApplication": { + "description": "**Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under \"Authorized OAuth Apps\" on GitHub](https://github.com/settings/applications#authorized).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateAuthorization": { + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication).\"\n\nYou can only send one of these scope keys at a time.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "orgs": { + "properties": { + "addOrUpdateMembership": { + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://developer.github.com/v3/orgs/members/#get-organization-membership) will be `pending` until they accept the invitation.\n\n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "blockUser": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "checkBlockedUser": { + "description": "If the user is blocked:\n\nIf the user is not blocked:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "checkMembership": { + "description": "Check if a user is, publicly or privately, a member of the organization.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "checkPublicMembership": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "concealMembership": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "convertMemberToOutsideCollaborator": { + "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\".", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createHook": { + "description": "Here's how you can create a hook that posts payloads in JSON format:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createInvitation": { + "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteHook": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "get": { + "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nGitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See \"[Authenticating with GitHub Apps](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see \"[Response with GitHub plan information](https://developer.github.com/v3/orgs/#response-with-github-plan-information).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getHook": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getMembership": { + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getMembershipForAuthenticatedUser": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "list": { + "description": "Lists all organizations, in the order that they were created on GitHub.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://developer.github.com/v3/#link-header) to get the URL for the next page of organizations.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listBlockedUsers": { + "description": "List the users blocked by an organization.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForAuthenticatedUser": { + "description": "List organizations for the authenticated user.\n\n**OAuth scope requirements**\n\nThis only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForUser": { + "description": "List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List your organizations](https://developer.github.com/v3/orgs/#list-your-organizations) API instead.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listHooks": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listInstallations": { + "description": "Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listInvitationTeams": { + "description": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listMembers": { + "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listMemberships": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listOutsideCollaborators": { + "description": "List all users who are outside collaborators of an organization.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPendingInvitations": { + "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPublicMembers": { + "description": "Members of an organization can choose to have their membership publicized or not.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "pingHook": { + "description": "This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) to be sent to the hook.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "publicizeMembership": { + "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeMember": { + "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeMembership": { + "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeOutsideCollaborator": { + "description": "Removing a user from this list will remove them from all the organization's repositories.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "unblockUser": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "update": { + "description": "**Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateHook": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateMembership": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "paginate": { + "$ref": "#/definitions/Octokit.Paginate" + }, + "projects": { + "properties": { + "addCollaborator": { + "description": "Adds a collaborator to a an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createCard": { + "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)\" endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createColumn": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createForAuthenticatedUser": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createForOrg": { + "description": "Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createForRepo": { + "description": "Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "delete": { + "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteCard": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteColumn": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "get": { + "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getCard": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getColumn": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listCards": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listCollaborators": { + "description": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listColumns": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForOrg": { + "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.\n\ns", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForRepo": { + "description": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForUser": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "moveCard": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "moveColumn": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeCollaborator": { + "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "reviewUserPermissionLevel": { + "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "update": { + "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateCard": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateColumn": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "pulls": { + "properties": { + "checkIfMerged": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "create": { + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createComment": { + "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Comments](https://developer.github.com/v3/issues/comments/#create-a-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://developer.github.com/v3/pulls/comments/#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createCommentReply": { + "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Comments](https://developer.github.com/v3/issues/comments/#create-a-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://developer.github.com/v3/pulls/comments/#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createFromIssue": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createReview": { + "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createReviewCommentReply": { + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createReviewRequest": { + "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteComment": { + "description": "Deletes a review comment.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deletePendingReview": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteReviewRequest": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "dismissReview": { + "description": "**Note:** To dismiss a pull request review on a [protected branch](https://developer.github.com/v3/repos/branches/), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "get": { + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://developer.github.com/v3/pulls/#create-a-pull-request), or [edit](https://developer.github.com/v3/pulls/#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getComment": { + "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getCommentsForReview": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getReview": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "list": { + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listComments": { + "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listCommentsForRepo": { + "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listCommits": { + "description": "Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [Commit List API](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listFiles": { + "description": "**Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listReviewRequests": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listReviews": { + "description": "The list of reviews returns in chronological order.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "merge": { + "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "submitReview": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "update": { + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateBranch": { + "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateComment": { + "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateReview": { + "description": "Update the review summary comment with new text.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "rateLimit": { + "properties": { + "get": { + "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Understanding your rate limit status**\n\nThe Search API has a [custom rate limit](https://developer.github.com/v3/search/#rate-limit), separate from the rate limit governing the rest of the REST API. The GraphQL API also has a [custom rate limit](https://developer.github.com/v4/guides/resource-limitations/#rate-limit) that is separate from and calculated differently than rate limits in the REST API.\n\nFor these reasons, the Rate Limit API response categorizes your rate limit. Under `resources`, you'll see four objects:\n\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the [Search API](https://developer.github.com/v3/search/).\n* The `graphql` object provides your rate limit status for the [GraphQL API](https://developer.github.com/v4/).\n* The `integration_manifest` object provides your rate limit status for the [GitHub App Manifest code conversion](https://developer.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration) endpoint.\n\nFor more information on the headers and values in the rate limit response, see \"[Rate limiting](https://developer.github.com/v3/#rate-limiting).\"\n\nThe `rate` object (shown at the bottom of the response above) is deprecated.\n\nIf you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "reactions": { + "properties": { + "createForCommitComment": { + "description": "Create a reaction to a [commit comment](https://developer.github.com/v3/repos/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this commit comment.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createForIssue": { + "description": "Create a reaction to an [issue](https://developer.github.com/v3/issues/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createForIssueComment": { + "description": "Create a reaction to an [issue comment](https://developer.github.com/v3/issues/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue comment.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createForPullRequestReviewComment": { + "description": "Create a reaction to a [pull request review comment](https://developer.github.com/v3/pulls/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this pull request review comment.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createForTeamDiscussion": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createForTeamDiscussionComment": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion comment`](https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment) endpoint.\n\nCreate a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createForTeamDiscussionCommentInOrg": { + "description": "Create a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createForTeamDiscussionCommentLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion comment`](https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment) endpoint.\n\nCreate a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createForTeamDiscussionInOrg": { + "description": "Create a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createForTeamDiscussionLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "delete": { + "description": "OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://developer.github.com/v3/teams/discussions/) or [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForCommitComment": { + "description": "List the reactions to a [commit comment](https://developer.github.com/v3/repos/comments/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForIssue": { + "description": "List the reactions to an [issue](https://developer.github.com/v3/issues/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForIssueComment": { + "description": "List the reactions to an [issue comment](https://developer.github.com/v3/issues/comments/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForPullRequestReviewComment": { + "description": "List the reactions to a [pull request review comment](https://developer.github.com/v3/pulls/comments/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForTeamDiscussion": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForTeamDiscussionComment": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForTeamDiscussionCommentInOrg": { + "description": "List the reactions to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForTeamDiscussionCommentLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForTeamDiscussionInOrg": { + "description": "List the reactions to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForTeamDiscussionLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "repos": { + "properties": { + "acceptInvitation": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addCollaborator": { + "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://developer.github.com/v3/repos/invitations/).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addDeployKey": { + "description": "Here's how you can create a read-only deploy key:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addProtectedBranchAdminEnforcement": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addProtectedBranchAppRestrictions": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addProtectedBranchRequiredSignatures": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addProtectedBranchRequiredStatusChecksContexts": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addProtectedBranchTeamRestrictions": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addProtectedBranchUserRestrictions": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "checkCollaborator": { + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "checkVulnerabilityAlerts": { + "description": "Shows whether vulnerability alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\" in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "compareCommits": { + "description": "Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\n**Working with large comparisons**\n\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [Commit List API](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository) to enumerate all commits in the range.\n\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long to generate. You can typically resolve this error by using a smaller commit range.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createCommitComment": { + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createDeployment": { + "description": "Deployments offer a few configurable parameters with sane defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them before we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter makes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response.\n\nBy default, [commit statuses](https://developer.github.com/v3/repos/statuses) for every submitted context must be in a `success` state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text field that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref:\n\nA simple example putting the user and room into the payload to notify back to chat networks.\n\nA more advanced example specifying required commit statuses and bypassing auto-merging.\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating a deployment. This auto-merge happens when:\n\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master`in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful response.\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createDeploymentStatus": { + "description": "Users with `push` access can create deployment statuses for a given deployment.\n\nGitHub Apps require `read & write` access to \"Deployments\" and `read-only` access to \"Repo contents\" (for private repos). OAuth Apps require the `repo_deployment` scope.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createDispatchEvent": { + "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://developer.github.com/v3/activity/events/types/#repositorydispatchevent).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. For a test example, see the [input example](https://developer.github.com/v3/repos/#example-4).\n\nTo give you write access to the repository, you must use a personal access token with the `repo` scope. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)\" in the GitHub Help documentation.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createFile": { + "description": "Creates a new file or updates an existing file in a repository.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createForAuthenticatedUser": { + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createFork": { + "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createHook": { + "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can share the same `config` as long as those webhooks do not have any `events` that overlap.\n\nHere's how you can create a hook that posts payloads in JSON format:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createInOrg": { + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createOrUpdateFile": { + "description": "Creates a new file or updates an existing file in a repository.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createRelease": { + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createStatus": { + "description": "Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createUsingTemplate": { + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [`GET /repos/:owner/:repo`](https://developer.github.com/v3/repos/#get) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository\n\n\\`\n *", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "declineInvitation": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "delete": { + "description": "Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteCommitComment": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteDownload": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteFile": { + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteHook": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteInvitation": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteRelease": { + "description": "Users with push access to the repository can delete a release.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteReleaseAsset": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "disableAutomatedSecurityFixes": { + "description": "Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)\" in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "disablePagesSite": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "disableVulnerabilityAlerts": { + "description": "Disables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\" in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "enableAutomatedSecurityFixes": { + "description": "Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)\" in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "enablePagesSite": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "enableVulnerabilityAlerts": { + "description": "Enables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\" in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "get": { + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getAppsWithAccessToProtectedBranch": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getArchiveLink": { + "description": "Gets a redirect URL to download an archive for a repository. The `:archive_format` can be either `tarball` or `zipball`. The `:ref` must be a valid Git reference. If you omit `:ref`, the repository’s default branch (usually `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the `Location` header to make a second `GET` request.\n\n_Note_: For private repositories, these links are temporary and expire after five minutes.\n\nTo follow redirects with curl, use the `-L` switch:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getBranch": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getBranchProtection": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getClones": { + "description": "Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getCodeFrequencyStats": { + "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getCollaboratorPermissionLevel": { + "description": "Possible values for the `permission` key: `admin`, `write`, `read`, `none`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getCombinedStatusForRef": { + "description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://developer.github.com/v3/#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getCommit": { + "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\nYou can pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.\n\nTo return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getCommitActivityStats": { + "description": "Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getCommitComment": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getCommitRefSha": { + "description": "**Note:** To access this endpoint, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```\n * application/vnd.github.VERSION.sha\n * ```\nReturns the SHA-1 of the commit reference. You must have `read` access for the repository to get the SHA-1 of a commit reference. You can use this endpoint to check if a remote reference's SHA-1 is the same as your local reference's SHA-1 by providing the local SHA-1 reference as the ETag.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getContents": { + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit `:path`, you will receive the contents of all files in the repository.\n\nFiles and symlinks support [a custom media type](https://developer.github.com/v3/repos/contents/#custom-media-types) for retrieving the raw content or rendered HTML (when supported). All content types support [a custom media type](https://developer.github.com/v3/repos/contents/#custom-media-types) to ensure the content is returned in a consistent object format.\n\n**Note**:\n\n* To get a repository's contents recursively, you can [recursively get the tree](https://developer.github.com/v3/git/trees/).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees API](https://developer.github.com/v3/git/trees/#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\nThe response will be an array of objects, one object for each item in the directory.\n\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value _should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as \"submodule\".\n\nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the API responds with the content of the file (in the [format shown above](https://developer.github.com/v3/repos/contents/#response-if-content-is-a-file)).\n\nOtherwise, the API responds with an object describing the symlink itself:\n\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getContributorsStats": { + "description": "* `total` - The Total number of commits authored by the contributor.\n\nWeekly Hash (`weeks` array):\n\n* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getDeployKey": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getDeployment": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getDeploymentStatus": { + "description": "Users with pull access can view a deployment status for a deployment:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getDownload": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getHook": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getLatestPagesBuild": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getLatestRelease": { + "description": "View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getPages": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getPagesBuild": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getParticipationStats": { + "description": "Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.\n\nThe array order is oldest week (index 0) to most recent week.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getProtectedBranchAdminEnforcement": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getProtectedBranchPullRequestReviewEnforcement": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getProtectedBranchRequiredSignatures": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getProtectedBranchRequiredStatusChecks": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getProtectedBranchRestrictions": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch. {{#note}}\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getPunchCardStats": { + "description": "Each array contains the day number, hour number, and number of commits:\n\n* `0-6`: Sunday - Saturday\n* `0-23`: Hour of day\n* Number of commits\n\nFor example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getReadme": { + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://developer.github.com/v3/repos/contents/#custom-media-types) for retrieving the raw content or rendered HTML.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getRelease": { + "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://developer.github.com/v3/#hypermedia).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getReleaseAsset": { + "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://developer.github.com/v3/media/#media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getReleaseByTag": { + "description": "Get a published release with the specified tag.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getTeamsWithAccessToProtectedBranch": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getTopPaths": { + "description": "Get the top 10 popular contents over the last 14 days.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getTopReferrers": { + "description": "Get the top 10 referrers over the last 14 days.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getUsersWithAccessToProtectedBranch": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getViews": { + "description": "Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "list": { + "description": "Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listAppsWithAccessToProtectedBranch": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listAssetsForRelease": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listBranches": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listBranchesForHeadCommit": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listCollaborators": { + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listCommentsForCommit": { + "description": "Use the `:commit_sha` to specify the commit that will have its comments listed.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listCommitComments": { + "description": "Commit Comments use [these custom media types](https://developer.github.com/v3/repos/comments/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).\n\nComments are ordered by ascending ID.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listCommits": { + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listContributors": { + "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listDeployKeys": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listDeploymentStatuses": { + "description": "Users with pull access can view deployment statuses for a deployment:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listDeployments": { + "description": "Simple filtering of deployments is available via query parameters:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listDownloads": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForOrg": { + "description": "Lists repositories for the specified organization.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForUser": { + "description": "Lists public repositories for the specified user.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForks": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listHooks": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listInvitations": { + "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listInvitationsForAuthenticatedUser": { + "description": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listLanguages": { + "description": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPagesBuilds": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listProtectedBranchRequiredStatusChecksContexts": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listProtectedBranchTeamRestrictions": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listProtectedBranchUserRestrictions": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPublic": { + "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://developer.github.com/v3/#link-header) to get the URL for the next page of repositories.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPullRequestsAssociatedWithCommit": { + "description": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listReleases": { + "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://developer.github.com/v3/repos/#list-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listStatusesForRef": { + "description": "Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.\n\nThis resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listTags": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listTeams": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listTeamsWithAccessToProtectedBranch": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listTopics": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listUsersWithAccessToProtectedBranch": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "merge": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "pingHook": { + "description": "This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) to be sent to the hook.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeBranchProtection": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeCollaborator": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeDeployKey": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeProtectedBranchAdminEnforcement": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeProtectedBranchAppRestrictions": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeProtectedBranchPullRequestReviewEnforcement": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeProtectedBranchRequiredSignatures": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeProtectedBranchRequiredStatusChecks": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeProtectedBranchRequiredStatusChecksContexts": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeProtectedBranchRestrictions": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeProtectedBranchTeamRestrictions": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeProtectedBranchUserRestrictions": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "replaceProtectedBranchAppRestrictions": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "replaceProtectedBranchRequiredStatusChecksContexts": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "replaceProtectedBranchTeamRestrictions": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "replaceProtectedBranchUserRestrictions": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "replaceTopics": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "requestPageBuild": { + "description": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "retrieveCommunityProfileMetrics": { + "description": "This endpoint will return all community profile metrics, including an overall health score, repository description, the presence of documentation, detected code of conduct, detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE, README, and CONTRIBUTING files.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "testPushHook": { + "description": "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.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "transfer": { + "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "update": { + "description": "**Note**: To edit a repository's topics, use the [`topics` endpoint](https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateBranchProtection": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateCommitComment": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateFile": { + "description": "Creates a new file or updates an existing file in a repository.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateHook": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateInformationAboutPagesSite": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateInvitation": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateProtectedBranchPullRequestReviewEnforcement": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateProtectedBranchRequiredStatusChecks": { + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateRelease": { + "description": "Users with push access to the repository can edit a release.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateReleaseAsset": { + "description": "Users with push access to the repository can edit a release asset.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "uploadReleaseAsset": { + "description": "This endpoint makes use of [a Hypermedia relation](https://developer.github.com/v3/#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in the response of the [Create a release endpoint](https://developer.github.com/v3/repos/releases/#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example:\n\n`application/zip`\n\nGitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, you'll still need to pass your authentication to be able to upload an asset.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "request": { + "$ref": "#/definitions/Octokit.Request" + }, + "search": { + "properties": { + "code": { + "description": "Find file contents via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\n**Note:** You must [authenticate](https://developer.github.com/v3/#authentication) to search for code across all public repositories.\n\n**Considerations for code search**\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\nSuppose you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery). Your query would look something like this:\n\nHere, we're searching for the keyword `addClass` within a file's contents. We're making sure that we're only looking in files where the language is JavaScript. And we're scoping the search to the `repo:jquery/jquery` repository.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "commits": { + "description": "Find commits via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\n**Considerations for commit search**\n\nOnly the _default branch_ is considered. In most cases, this will be the `master` branch.\n\nSuppose you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "emailLegacy": { + "description": "This API call is added for compatibility reasons only. There's no guarantee that full email searches will always be available. The `@` character in the address must be left unencoded. Searches only against public email addresses (as configured on the user's GitHub profile).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "issues": { + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\nLet's say you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\nIn this query, we're searching for the keyword `windows`, within any open issue that's labeled as `bug`. The search runs across repositories whose primary language is Python. We’re sorting by creation date in ascending order, so that the oldest issues appear first in the search results.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "issuesAndPullRequests": { + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\nLet's say you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\nIn this query, we're searching for the keyword `windows`, within any open issue that's labeled as `bug`. The search runs across repositories whose primary language is Python. We’re sorting by creation date in ascending order, so that the oldest issues appear first in the search results.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "issuesLegacy": { + "description": "Find issues by state and keyword.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "labels": { + "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\nSuppose you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\nThe labels that best match for the query appear first in the search results.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "repos": { + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\nSuppose you want to search for popular Tetris repositories written in Assembly. Your query might look like this.\n\nYou can search for multiple topics by adding more `topic:` instances, and including the `mercy-preview` header. For example:\n\nIn this request, we're searching for repositories with the word `tetris` in the name, the description, or the README. We're limiting the results to only find repositories where the primary language is Assembly. We're sorting by stars in descending order, so that the most popular repositories appear first in the search results.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "reposLegacy": { + "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.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "topics": { + "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\nSee \"[Searching topics](https://help.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nSuppose you want to search for topics related to Ruby that are featured on [https://github.com/topics](https://github.com/topics). Your query might look like this:\n\nIn this request, we're searching for topics with the keyword `ruby`, and we're limiting the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.\n\n**Note:** A search for featured Ruby topics only has 6 total results, so a [Link header](https://developer.github.com/v3/#link-header) indicating pagination is not included in the response.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "users": { + "description": "Find users via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\nImagine you're looking for a list of popular users. You might try out this query:\n\nHere, we're looking at users with the name Tom. We're only interested in those with more than 42 repositories, and only if they have over 1,000 followers.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "usersLegacy": { + "description": "Find users by keyword.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "teams": { + "properties": { + "addMember": { + "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add team membership](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addMemberLegacy": { + "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add team membership](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addOrUpdateMembership": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team membership`](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addOrUpdateMembershipInOrg": { + "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/:org_id/team/:team_id/memberships/:username`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addOrUpdateMembershipLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team membership`](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addOrUpdateProject": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team project`](https://developer.github.com/v3/teams/#add-or-update-team-project) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addOrUpdateProjectInOrg": { + "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/:org_id/team/:team_id/projects/:project_id`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addOrUpdateProjectLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team project`](https://developer.github.com/v3/teams/#add-or-update-team-project) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addOrUpdateRepo": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team repository`](https://developer.github.com/v3/teams/#add-or-update-team-repository) endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addOrUpdateRepoInOrg": { + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/:org_id/team/:team_id/repos/:owner/:repo`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "addOrUpdateRepoLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team repository`](https://developer.github.com/v3/teams/#add-or-update-team-repository) endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "checkManagesRepo": { + "description": "**Note**: Repositories inherited through a parent team will also be checked.\n\n**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Check if a team manages a repository`](https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository) endpoint.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "checkManagesRepoInOrg": { + "description": "Checks whether a team has `admin`, `push`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/repos/:owner/:repo`.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "checkManagesRepoLegacy": { + "description": "**Note**: Repositories inherited through a parent team will also be checked.\n\n**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Check if a team manages a repository`](https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository) endpoint.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "create": { + "description": "To create a team, the authenticated user must be a member or owner of `:org`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\" in the GitHub Help documentation.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createDiscussion": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://developer.github.com/v3/teams/discussions/#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createDiscussionComment": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a comment`](https://developer.github.com/v3/teams/discussion_comments/#create-a-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createDiscussionCommentInOrg": { + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createDiscussionCommentLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a comment`](https://developer.github.com/v3/teams/discussion_comments/#create-a-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createDiscussionInOrg": { + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createDiscussionLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://developer.github.com/v3/teams/discussions/#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "delete": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete team`](https://developer.github.com/v3/teams/#delete-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteDiscussion": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://developer.github.com/v3/teams/discussions/#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteDiscussionComment": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a comment`](https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment) endpoint.\n\nDeletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteDiscussionCommentInOrg": { + "description": "Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteDiscussionCommentLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a comment`](https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment) endpoint.\n\nDeletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteDiscussionInOrg": { + "description": "Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteDiscussionLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://developer.github.com/v3/teams/discussions/#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteInOrg": { + "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id`.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete team`](https://developer.github.com/v3/teams/#delete-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "get": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [`Get team by name`](https://developer.github.com/v3/teams/#get-team-by-name) endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getByName": { + "description": "Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getDiscussion": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get a single discussion`](https://developer.github.com/v3/teams/discussions/#get-a-single-discussion) endpoint.\n\nGet a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getDiscussionComment": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get a single comment`](https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment) endpoint.\n\nGet a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getDiscussionCommentInOrg": { + "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getDiscussionCommentLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get a single comment`](https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment) endpoint.\n\nGet a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getDiscussionInOrg": { + "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getDiscussionLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get a single discussion`](https://developer.github.com/v3/teams/discussions/#get-a-single-discussion) endpoint.\n\nGet a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [`Get team by name`](https://developer.github.com/v3/teams/#get-team-by-name) endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getMember": { + "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership](https://developer.github.com/v3/teams/members/#get-team-membership) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getMemberLegacy": { + "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership](https://developer.github.com/v3/teams/members/#get-team-membership) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getMembership": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get team membership`](https://developer.github.com/v3/teams/members/#get-team-membership) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create team](https://developer.github.com/v3/teams#create-team).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getMembershipInOrg": { + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/memberships/:username`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create team](https://developer.github.com/v3/teams#create-team).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getMembershipLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get team membership`](https://developer.github.com/v3/teams/members/#get-team-membership) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create team](https://developer.github.com/v3/teams#create-team).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "list": { + "description": "Lists all teams in an organization that are visible to the authenticated user.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listChild": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://developer.github.com/v3/teams/#list-child-teams) endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listChildInOrg": { + "description": "Lists the child teams of the team requested by `:team_slug`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/teams`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listChildLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://developer.github.com/v3/teams/#list-child-teams) endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listDiscussionComments": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List comments`](https://developer.github.com/v3/teams/discussion_comments/#list-comments) endpoint.\n\nList all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listDiscussionCommentsInOrg": { + "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listDiscussionCommentsLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List comments`](https://developer.github.com/v3/teams/discussion_comments/#list-comments) endpoint.\n\nList all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listDiscussions": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://developer.github.com/v3/teams/discussions/#list-discussions) endpoint.\n\nList all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listDiscussionsInOrg": { + "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listDiscussionsLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://developer.github.com/v3/teams/discussions/#list-discussions) endpoint.\n\nList all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listForAuthenticatedUser": { + "description": "List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://developer.github.com/apps/building-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listMembers": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://developer.github.com/v3/teams/members/#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listMembersInOrg": { + "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listMembersLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://developer.github.com/v3/teams/members/#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPendingInvitations": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://developer.github.com/v3/teams/members/#list-pending-team-invitations) endpoint.\n\nThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPendingInvitationsInOrg": { + "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/invitations`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPendingInvitationsLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://developer.github.com/v3/teams/members/#list-pending-team-invitations) endpoint.\n\nThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listProjects": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://developer.github.com/v3/teams/#list-team-projects) endpoint.\n\nLists the organization projects for a team.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listProjectsInOrg": { + "description": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/projects`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listProjectsLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://developer.github.com/v3/teams/#list-team-projects) endpoint.\n\nLists the organization projects for a team.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listRepos": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team repos`](https://developer.github.com/v3/teams/#list-team-repos) endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listReposInOrg": { + "description": "Lists a team's repositories visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/repos`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listReposLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team repos`](https://developer.github.com/v3/teams/#list-team-repos) endpoint.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeMember": { + "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership](https://developer.github.com/v3/teams/members/#remove-team-membership) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeMemberLegacy": { + "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership](https://developer.github.com/v3/teams/members/#remove-team-membership) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeMembership": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team membership`](https://developer.github.com/v3/teams/members/#remove-team-membership) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo 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. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeMembershipInOrg": { + "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo 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. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/memberships/:username`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeMembershipLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team membership`](https://developer.github.com/v3/teams/members/#remove-team-membership) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo 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. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeProject": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team project`](https://developer.github.com/v3/teams/#remove-team-project) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeProjectInOrg": { + "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/projects/:project_id`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeProjectLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team project`](https://developer.github.com/v3/teams/#remove-team-project) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeRepo": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team repository`](https://developer.github.com/v3/teams/#remove-team-repository) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeRepoInOrg": { + "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/repos/:owner/:repo`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "removeRepoLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team repository`](https://developer.github.com/v3/teams/#remove-team-repository) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "reviewProject": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Review a team project`](https://developer.github.com/v3/teams/#review-a-team-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "reviewProjectInOrg": { + "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/projects/:project_id`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "reviewProjectLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Review a team project`](https://developer.github.com/v3/teams/#review-a-team-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "update": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit team`](https://developer.github.com/v3/teams/#edit-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateDiscussion": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit a discussion`](https://developer.github.com/v3/teams/discussions/#edit-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateDiscussionComment": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit a comment`](https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment) endpoint.\n\nEdits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateDiscussionCommentInOrg": { + "description": "Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateDiscussionCommentLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit a comment`](https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment) endpoint.\n\nEdits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateDiscussionInOrg": { + "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/:org_id/team/:team_id/discussions/:discussion_number`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateDiscussionLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit a discussion`](https://developer.github.com/v3/teams/discussions/#edit-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateInOrg": { + "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/:org_id/team/:team_id`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateLegacy": { + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit team`](https://developer.github.com/v3/teams/#edit-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "users": { + "properties": { + "addEmails": { + "description": "This endpoint is accessible with the `user` scope.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "block": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "checkBlocked": { + "description": "If the user is blocked:\n\nIf the user is not blocked:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "checkFollowing": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "checkFollowingForUser": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createGpgKey": { + "description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "createPublicKey": { + "description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteEmails": { + "description": "This endpoint is accessible with the `user` scope.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deleteGpgKey": { + "description": "Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "deletePublicKey": { + "description": "Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "follow": { + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"\n\nFollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getAuthenticated": { + "description": "Lists public and private profile information when authenticated through basic auth or OAuth with the `user` scope.\n\nLists public profile information when authenticated through OAuth without the `user` scope.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getByUsername": { + "description": "Provides publicly available information about someone with a GitHub account.\n\nGitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See \"[Identifying and authorizing users for GitHub Apps](https://developer.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)\" for details about authentication. For an example response, see \"[Response with GitHub plan information](https://developer.github.com/v3/users/#response-with-github-plan-information).\"\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://developer.github.com/v3/#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://developer.github.com/v3/users/emails/)\".", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getContextForUser": { + "description": "Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\nThe `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getGpgKey": { + "description": "View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "getPublicKey": { + "description": "View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "list": { + "description": "Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://developer.github.com/v3/#link-header) to get the URL for the next page of users.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listBlocked": { + "description": "List the users you've blocked on your personal account.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listEmails": { + "description": "Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listFollowersForAuthenticatedUser": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listFollowersForUser": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listFollowingForAuthenticatedUser": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listFollowingForUser": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listGpgKeys": { + "description": "Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listGpgKeysForUser": { + "description": "Lists the GPG keys for a user. This information is accessible by anyone.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPublicEmails": { + "description": "Lists your publicly visible email address, which you can set with the [Toggle primary email visibility](https://developer.github.com/v3/users/emails/#toggle-primary-email-visibility) endpoint. This endpoint is accessible with the `user:email` scope.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPublicKeys": { + "description": "Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "listPublicKeysForUser": { + "description": "Lists the _verified_ public SSH keys for a user. This is accessible by anyone.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "togglePrimaryEmailVisibility": { + "description": "Sets the visibility for your primary email addresses.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "unblock": { + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "unfollow": { + "description": "Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + }, + "updateAuthenticated": { + "description": "**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.", + "properties": { + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" + } + }, + "type": "object" + } + }, + "type": "object" } }, "type": "object" }, - "GitHubRepo": { - "description": "A GitHub Repo", + "Octokit.Endpoint": { "properties": { - "assignee": { - "$ref": "#/definitions/GitHubUser", - "description": "Is someone assigned to this PR?" - }, - "assignees": { - "description": "Are there people assigned to this PR?", - "items": { - "$ref": "#/definitions/GitHubUser" - }, - "type": "array" - }, - "description": { - "description": "The textual description of the repo", - "type": "string" - }, - "fork": { - "description": "Is the repo a fork?", - "type": "boolean" - }, - "full_name": { - "description": "The full name of the owner + repo, e.g. \"Danger/Danger-JS\"", - "type": "string" - }, - "html_url": { - "description": "The root web URL for the repo, e.g. https://github.com/artsy/emission", - "type": "string" - }, - "id": { - "description": "Generic UUID", - "type": "number" - }, - "name": { - "description": "The name of the repo, e.g. \"Danger-JS\"", - "type": "string" - }, - "owner": { - "$ref": "#/definitions/GitHubUser", - "description": "The owner of the repo" - }, - "private": { - "description": "Is the repo publicly accessible?", - "type": "boolean" + "DEFAULTS": { + "$ref": "#/definitions/Octokit.EndpointOptions", + "description": "Current default options" } }, "type": "object" }, - "GitHubReview": { - "description": "GitHubReview\nWhile a review is pending, it will only have a user. Once a review is complete, the rest of\nthe review attributes will be present", + "Octokit.EndpointOptions": { + "additionalProperties": { + }, "properties": { - "body": { - "description": "If there is a review, the body of the review", + "baseUrl": { "type": "string" }, - "commit_id": { - "description": "If there is a review, the commit ID this review was made on", - "type": "string" + "data": { }, - "id": { - "description": "If there is a review, this provides the ID for it", - "type": "number" + "headers": { + "additionalProperties": { + }, + "type": "object" }, - "state": { - "description": "The state of the review\nAPPROVED, REQUEST_CHANGES, COMMENT or PENDING", + "method": { "enum": [ - "APPROVED", - "COMMENT", - "PENDING", - "REQUEST_CHANGES" + "DELETE", + "GET", + "HEAD", + "PATCH", + "POST", + "PUT" ], "type": "string" }, - "user": { - "$ref": "#/definitions/GitHubUser", - "description": "The user requested to review, or the user who has completed the review" - } - }, - "type": "object" - }, - "GitHubUser": { - "description": "A GitHub user account.", - "properties": { - "avatar_url": { - "description": "The url for a users's image", - "type": "string" - }, - "id": { - "description": "Generic UUID", - "type": "number" - }, - "login": { - "description": "The handle for the user/org", - "type": "string" + "request": { + "additionalProperties": { + }, + "type": "object" }, - "type": { - "description": "Whether the user is an org, or a user", - "enum": [ - "Bot", - "Organization", - "User" - ], + "url": { "type": "string" } }, "type": "object" }, - "GitHubUtilsDSL": { - "description": "Useful functions for GitHub related work", + "Octokit.Log": { "properties": { - "createOrAddLabel": { - "description": "An API for creating, or setting a label to an issue. Usable from Peril\nby adding an additional param for settings about a repo.", + "debug": { "type": "object" }, - "createOrUpdatePR": { + "error": { "type": "object" }, - "createUpdatedIssueWithID": { - "description": "An API for creating, updating and closing an issue. Basically\nthis is really useful for reporting back via a separate\nissue that you may want to keep up to date at all times.", + "info": { "type": "object" - } - }, - "type": "object" - }, - "GitJSONDSL": { - "description": "The Git Related Metadata which is available inside the Danger DSL JSON", - "properties": { - "commits": { - "description": "The Git commit metadata", - "items": { - "$ref": "#/definitions/GitCommit" - }, - "type": "array" - }, - "created_files": { - "description": "Newly created filepaths relative to the git root", - "items": { - "type": "string" - }, - "type": "array" - }, - "deleted_files": { - "description": "Removed filepaths relative to the git root", - "items": { - "type": "string" - }, - "type": "array" }, - "modified_files": { - "description": "Filepaths with changes relative to the git root", - "items": { - "type": "string" - }, - "type": "array" + "warn": { + "type": "object" } }, "type": "object" }, - "Github": { + "Octokit.Paginate": { "properties": { - "activity": { - "type": "object" - }, - "apps": { - "type": "object" - }, - "checks": { - "type": "object" - }, - "codesOfConduct": { - "type": "object" - }, - "emojis": { - "type": "object" - }, - "gists": { - "type": "object" - }, - "git": { - "type": "object" - }, - "gitignore": { - "type": "object" - }, - "hook": { - "type": "object" - }, - "interactions": { - "type": "object" - }, - "issues": { - "type": "object" - }, - "licenses": { - "type": "object" - }, - "markdown": { - "type": "object" - }, - "meta": { - "type": "object" - }, - "migrations": { - "type": "object" - }, - "oauthAuthorizations": { - "type": "object" - }, - "orgs": { - "type": "object" - }, - "projects": { - "type": "object" - }, - "pulls": { - "type": "object" - }, - "rateLimit": { - "type": "object" - }, - "reactions": { - "type": "object" - }, - "repos": { - "type": "object" - }, - "request": { - }, - "search": { - "type": "object" - }, - "teams": { - "type": "object" - }, - "users": { + "iterator": { "type": "object" } }, "type": "object" }, - "JIRAIssue": { - "description": "This is `danger.bitbucket_server.issues` It refers to the issues that are linked to the Pull Request.", + "Octokit.Request": { "properties": { - "key": { - "description": "The unique key for the issue e.g. JRA-11", - "type": "string" - }, - "url": { - "description": "The user-facing URL for that issue", - "type": "string" + "endpoint": { + "$ref": "#/definitions/Octokit.Endpoint" } }, "type": "object" diff --git a/source/danger-outgoing-process-schema.json b/source/danger-outgoing-process-schema.json index 8765350b2..099a7ba7d 100644 --- a/source/danger-outgoing-process-schema.json +++ b/source/danger-outgoing-process-schema.json @@ -8,6 +8,10 @@ "description": "Optional path to the file", "type": "string" }, + "icon": { + "description": "Optional icon for table (Only valid for messages)", + "type": "string" + }, "line": { "description": "Optional line in the file", "type": "number"