diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 9b6e01886859..1259f8093aaa 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -298,7 +298,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -326,6 +327,14 @@ "subcategoryLabel": "Webhooks", "notes": [], "descriptionHTML": "

Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"

\n

You must use a JWT to access this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" + } + ], "bodyParameters": [ { "type": "string", @@ -371,17 +380,10 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" - } ] }, { @@ -5492,7 +5494,7 @@ "properties": { "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -5578,7 +5580,7 @@ "bodyParameters": [ { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -5731,7 +5733,7 @@ }, "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -5811,7 +5813,7 @@ }, { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -5954,7 +5956,7 @@ }, "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -6025,7 +6027,7 @@ }, { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -6204,7 +6206,7 @@ "properties": { "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -6294,7 +6296,7 @@ "bodyParameters": [ { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -9890,7 +9892,8 @@ ], "name": "public", "in": "body", - "description": "

undefined

", + "description": "

Flag indicating whether the gist is public

", + "type": "boolean or string", "childParamsGroups": [] } }, @@ -10000,7 +10003,8 @@ ], "name": "public", "in": "body", - "description": "

undefined

", + "description": "

Flag indicating whether the gist is public

", + "type": "boolean or string", "childParamsGroups": [] } ] @@ -14259,7 +14263,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -14483,7 +14487,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -18666,7 +18670,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "username": { @@ -18675,7 +18680,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "password": { @@ -18684,7 +18689,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -18745,7 +18750,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -18754,7 +18760,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -18763,7 +18769,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -18906,7 +18912,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "username": { @@ -18915,7 +18922,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "password": { @@ -18924,7 +18931,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -18985,7 +18992,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -18994,7 +19002,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -19003,7 +19011,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -19212,7 +19220,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -19273,7 +19282,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } ] @@ -19311,7 +19321,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -19406,7 +19416,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -19467,7 +19478,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } ] @@ -19505,7 +19517,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -19750,7 +19762,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -19779,6 +19792,14 @@ "subcategoryLabel": "Webhooks", "notes": [], "descriptionHTML": "

Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"

\n

Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:write permission.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" + } + ], "bodyParameters": [ { "type": "string", @@ -19824,17 +19845,10 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" - } ] }, { @@ -21684,7 +21698,7 @@ "name": "exclude", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -21759,7 +21773,7 @@ "name": "exclude", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -25151,7 +25165,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -25230,7 +25244,7 @@ "childParamsGroups": [] }, { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -29062,7 +29076,7 @@ "note": { "description": "

The project card's note

", "example": "Update all gems", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "note", "in": "body", @@ -29110,7 +29124,7 @@ { "description": "

The project card's note

", "example": "Update all gems", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "note", "in": "body", @@ -29859,10 +29873,35 @@ "type": "object", "properties": { "note": { - "description": "The project card's note", + "description": "

Required. The project card's note

", "example": "Update all gems", + "type": "string or nullable", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + "content_id": { + "description": "

Required. The unique identifier of the content associated with the card

", + "example": 42, + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] + }, + "content_type": { + "description": "

Required. The piece of content associated with the card

", + "example": "PullRequest", "type": "string", - "nullable": true + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] } }, "required": [ @@ -29873,14 +29912,24 @@ "type": "object", "properties": { "content_id": { - "description": "The unique identifier of the content associated with the card", + "description": "

Required. The unique identifier of the content associated with the card

", "example": 42, - "type": "integer" + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] }, "content_type": { - "description": "The piece of content associated with the card", + "description": "

Required. The piece of content associated with the card

", "example": "PullRequest", - "type": "string" + "type": "string", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] } }, "required": [ @@ -29913,8 +29962,40 @@ "subcategory": "cards", "subcategoryLabel": "Cards", "notes": [], - "bodyParameters": [], "descriptionHTML": "

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

Be 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\" endpoint.

", + "bodyParameters": [ + { + "description": "

Required. The project card's note

", + "example": "Update all gems", + "type": "string or nullable", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + { + "description": "

Required. The unique identifier of the content associated with the card

", + "example": 42, + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] + }, + { + "description": "

Required. The piece of content associated with the card

", + "example": "PullRequest", + "type": "string", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "201", @@ -30210,7 +30291,7 @@ "body": { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -30291,7 +30372,7 @@ { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -36464,7 +36545,7 @@ "type": "object", "properties": { "required_status_checks": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require status checks to pass before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -36530,7 +36611,7 @@ ] }, "enforce_admins": { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "nullable": true, "name": "enforce_admins", @@ -36540,7 +36621,7 @@ "childParamsGroups": [] }, "required_pull_request_reviews": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -36779,7 +36860,7 @@ ] }, "restrictions": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "nullable": true, "properties": { @@ -36884,7 +36965,7 @@ "childParamsGroups": [] }, "allow_force_pushes": { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "nullable": true, "name": "allow_force_pushes", @@ -36999,7 +37080,7 @@ "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Protecting a branch requires admin or owner permissions to the repository.

\n

Note: Passing new arrays of users and teams replaces their previous values.

\n

Note: The list of users, apps, and teams in total is limited to 100 items.

", "bodyParameters": [ { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require status checks to pass before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -37065,7 +37146,7 @@ ] }, { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "nullable": true, "name": "enforce_admins", @@ -37075,7 +37156,7 @@ "childParamsGroups": [] }, { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -37314,7 +37395,7 @@ ] }, { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "nullable": true, "properties": { @@ -37419,7 +37500,7 @@ "childParamsGroups": [] }, { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "nullable": true, "name": "allow_force_pushes", @@ -38997,11 +39078,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -39039,8 +39125,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -39131,11 +39230,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -39173,8 +39277,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -39260,11 +39377,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -39302,8 +39424,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -39641,11 +39776,16 @@ "type": "object", "properties": { "apps": { - "type": "array", - "description": "apps parameter", + "type": "array of strings", + "description": "

Required. apps parameter

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } }, "required": [ @@ -39682,8 +39822,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -39764,11 +39917,16 @@ "type": "object", "properties": { "apps": { - "type": "array", - "description": "apps parameter", + "type": "array of strings", + "description": "

Required. apps parameter

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } }, "required": [ @@ -39805,8 +39963,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -39887,11 +40058,16 @@ "type": "object", "properties": { "apps": { - "type": "array", - "description": "apps parameter", + "type": "array of strings", + "description": "

Required. apps parameter

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } }, "required": [ @@ -39928,8 +40104,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -40096,11 +40285,16 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -40138,8 +40332,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified teams push access for this branch. You can also give push access to child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -40220,11 +40427,16 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -40262,8 +40474,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -40344,11 +40569,16 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -40386,8 +40616,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a team to push to this branch. You can also remove push access for child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayTeams 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -40554,11 +40797,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -40595,8 +40843,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified people push access for this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -40677,11 +40938,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -40718,8 +40984,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -40800,11 +41079,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -40841,8 +41125,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a user to push to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -46232,7 +46529,7 @@ "childParamsGroups": [] }, "dismissed_reason": { - "type": "string or null", + "type": "string or nullable", "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "nullable": true, "oneOf": [ @@ -46278,6 +46575,29 @@ "categoryLabel": "Code scanning", "notes": [], "descriptionHTML": "

Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if the repository is archived or if github advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "description": "

Required. Sets the state of the code scanning alert. Can be one of open or dismissed. You must provide dismissed_reason when you set the state to dismissed.

", @@ -46293,7 +46613,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "nullable": true, "oneOf": [ @@ -46316,29 +46636,6 @@ "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -47421,7 +47718,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -47468,7 +47765,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -50206,7 +50503,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -50248,7 +50545,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -50283,7 +50580,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -50325,7 +50622,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -50474,7 +50771,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -50516,7 +50813,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -50551,7 +50848,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -50593,7 +50890,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -51363,7 +51660,8 @@ ], "name": "payload", "in": "body", - "description": "

undefined

", + "description": "

JSON payload with extra information about the deployment.

", + "type": "object or string", "childParamsGroups": [] }, "environment": { @@ -51377,7 +51675,7 @@ "childParamsGroups": [] }, "description": { - "type": "string or null", + "type": "string or nullable", "description": "

Short description of the deployment.

", "default": "", "nullable": true, @@ -51412,7 +51710,7 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -51467,6 +51765,30 @@ "subcategoryLabel": "Deployments", "notes": [], "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Simple example", + "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
" + }, + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Merged branch response", + "payload": "
{\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
" + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Conflict when there is a merge conflict or the commit's status checks failed" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ], "bodyParameters": [ { "type": "string", @@ -51523,7 +51845,8 @@ ], "name": "payload", "in": "body", - "description": "

undefined

", + "description": "

JSON payload with extra information about the deployment.

", + "type": "object or string", "childParamsGroups": [] }, { @@ -51537,7 +51860,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Short description of the deployment.

", "default": "", "nullable": true, @@ -51572,33 +51895,9 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Simple example", - "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
" - }, - { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "Merged branch response", - "payload": "
{\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
" - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Conflict when there is a merge conflict or the commit's status checks failed" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } ] }, { @@ -52655,7 +52954,7 @@ "childParamsGroups": [] }, "reviewers": { - "type": "array of objects or null", + "type": "array of objects or nullable", "nullable": true, "description": "

The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

", "items": { @@ -52726,7 +53025,7 @@ ] }, "deployment_branch_policy": { - "type": "object or null", + "type": "object or nullable", "description": "

The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

", "properties": { "protected_branches": { @@ -52830,7 +53129,7 @@ "childParamsGroups": [] }, { - "type": "array of objects or null", + "type": "array of objects or nullable", "nullable": true, "description": "

The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

", "items": { @@ -52901,7 +53200,7 @@ ] }, { - "type": "object or null", + "type": "object or nullable", "description": "

The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

", "properties": { "protected_branches": { @@ -54440,7 +54739,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -54495,7 +54794,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -55263,7 +55562,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -55333,7 +55632,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -55467,7 +55766,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -55537,7 +55836,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -55881,7 +56180,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "token": { @@ -55890,7 +56190,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "digest": { @@ -55899,7 +56199,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -55957,7 +56257,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -55966,7 +56267,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -55975,7 +56276,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -56121,7 +56422,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "token": { @@ -56130,7 +56432,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "digest": { @@ -56139,7 +56441,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -56197,7 +56499,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -56206,7 +56509,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -56215,7 +56518,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -56442,7 +56745,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "address": { @@ -56451,7 +56755,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "room": { @@ -56460,7 +56764,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -56521,7 +56825,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -56530,7 +56835,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -56539,7 +56844,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -56687,7 +56992,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "address": { @@ -56696,7 +57002,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "room": { @@ -56705,7 +57011,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -56766,7 +57072,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -56775,7 +57082,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -56784,7 +57091,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -57110,7 +57417,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -57138,6 +57446,14 @@ "subcategoryLabel": "Webhooks", "notes": [], "descriptionHTML": "

Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"

\n

Access tokens must have the write:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:write permission.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" + } + ], "bodyParameters": [ { "type": "string", @@ -57183,17 +57499,10 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" - } ] }, { @@ -57716,7 +58025,7 @@ "name": "vcs", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "tfvc_project": { @@ -57725,7 +58034,7 @@ "name": "tfvc_project", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -57782,7 +58091,7 @@ "name": "vcs", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -57791,7 +58100,7 @@ "name": "tfvc_project", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -59254,6 +59563,7 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "string or integer", "childParamsGroups": [] }, "body": { @@ -59266,7 +59576,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or null", + "type": "string or nullable", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "nullable": true, "name": "assignee", @@ -59288,12 +59598,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, "labels": { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -59371,6 +59681,39 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "oneOf": [ @@ -59385,6 +59728,7 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "string or integer", "childParamsGroups": [] }, { @@ -59397,7 +59741,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "nullable": true, "name": "assignee", @@ -59419,12 +59763,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -59470,39 +59814,6 @@ "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -60712,11 +61023,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "undefined or null", + "type": "string or integer or nullable", "childParamsGroups": [] }, "body": { - "type": "string or null", + "type": "string or nullable", "description": "

The contents of the issue.

", "nullable": true, "name": "body", @@ -60726,7 +61037,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or null", + "type": "string or nullable", "nullable": true, "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", @@ -60761,12 +61072,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, "labels": { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -60841,6 +61152,44 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

Issue owners and users with push access can edit an issue.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "oneOf": [ @@ -60856,11 +61205,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "undefined or null", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The contents of the issue.

", "nullable": true, "name": "body", @@ -60870,7 +61219,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "nullable": true, "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", @@ -60905,12 +61254,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -60956,44 +61305,6 @@ "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -61786,12 +62097,17 @@ "type": "object", "properties": { "labels": { - "type": "array", + "type": "array of strings", "minItems": 1, - "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "description": "

The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

", "items": { "type": "string" - } + }, + "name": "labels", + "in": "body", + "rawType": "array", + "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "childParamsGroups": [] } } }, @@ -61864,8 +62180,22 @@ "subcategory": "labels", "subcategoryLabel": "Labels", "notes": [], - "bodyParameters": [], "descriptionHTML": "", + "bodyParameters": [ + { + "type": "array of strings", + "minItems": 1, + "description": "

The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

", + "items": { + "type": "string" + }, + "name": "labels", + "in": "body", + "rawType": "array", + "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -65635,7 +65965,7 @@ "type": "object", "properties": { "cname": { - "type": "string or null", + "type": "string or nullable", "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

", "nullable": true, "name": "cname", @@ -65698,7 +66028,8 @@ ], "name": "source", "in": "body", - "description": "

undefined

", + "type": "", + "description": "", "childParamsGroups": [] } }, @@ -65768,7 +66099,7 @@ "descriptionHTML": "

Updates information for a GitHub Pages site. For more information, see \"About GitHub Pages.

", "bodyParameters": [ { - "type": "string or null", + "type": "string or nullable", "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

", "nullable": true, "name": "cname", @@ -65831,7 +66162,8 @@ ], "name": "source", "in": "body", - "description": "

undefined

", + "type": "", + "description": "", "childParamsGroups": [] } ] @@ -66804,7 +67136,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -66896,7 +67228,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -68344,7 +68676,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -68489,7 +68821,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -69786,7 +70118,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "side": { @@ -69795,7 +70127,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_line": { @@ -69804,7 +70136,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_side": { @@ -69813,7 +70145,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -69865,7 +70197,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -69874,7 +70206,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -69883,7 +70215,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -69892,7 +70224,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -70021,7 +70353,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "side": { @@ -70030,7 +70362,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_line": { @@ -70039,7 +70371,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_side": { @@ -70048,7 +70380,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -70100,7 +70432,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -70109,7 +70441,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -70118,7 +70450,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -70127,7 +70459,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -70659,7 +70991,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -70700,7 +71032,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -71722,7 +72054,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -71773,7 +72105,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -72915,7 +73247,7 @@ "childParamsGroups": [] }, "resolution": { - "type": "string or null", + "type": "string or nullable", "description": "

Required when the state is resolved. The reason for resolving the alert. Can be one of false_positive, wont_fix, revoked, or used_in_tests.

", "nullable": true, "oneOf": [ @@ -72962,6 +73294,29 @@ "categoryLabel": "Secret scanning", "notes": [], "descriptionHTML": "

Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

\n

GitHub Apps must have the secret_scanning_alerts write permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-11-06T18:18:30Z\",\n  \"url\": \"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/owner/private-repo/security/secret-scanning/42\",\n  \"state\": \"resolved\",\n  \"resolution\": \"used_in_tests\",\n  \"resolved_at\": \"2020-11-16T22:42:07Z\",\n  \"resolved_by\": {\n    \"login\": \"monalisa\",\n    \"id\": 2,\n    \"node_id\": \"MDQ6VXNlcjI=\",\n    \"avatar_url\": \"https://alambic.github.com/avatars/u/2?\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/monalisa\",\n    \"html_url\": \"https://github.com/monalisa\",\n    \"followers_url\": \"https://api.github.com/users/monalisa/followers\",\n    \"following_url\": \"https://api.github.com/users/monalisa/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/monalisa/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/monalisa/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/monalisa/orgs\",\n    \"repos_url\": \"https://api.github.com/users/monalisa/repos\",\n    \"events_url\": \"https://api.github.com/users/monalisa/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/monalisa/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": true\n  },\n  \"secret_type\": \"mailchimp_api_key\",\n  \"secret\": \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"\n}\n
" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "State does not match the resolution" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "description": "

Required. Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.

", @@ -72977,7 +73332,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Required when the state is resolved. The reason for resolving the alert. Can be one of false_positive, wont_fix, revoked, or used_in_tests.

", "nullable": true, "oneOf": [ @@ -73001,29 +73356,6 @@ "rawDescription": "**Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`.", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-11-06T18:18:30Z\",\n  \"url\": \"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/owner/private-repo/security/secret-scanning/42\",\n  \"state\": \"resolved\",\n  \"resolution\": \"used_in_tests\",\n  \"resolved_at\": \"2020-11-16T22:42:07Z\",\n  \"resolved_by\": {\n    \"login\": \"monalisa\",\n    \"id\": 2,\n    \"node_id\": \"MDQ6VXNlcjI=\",\n    \"avatar_url\": \"https://alambic.github.com/avatars/u/2?\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/monalisa\",\n    \"html_url\": \"https://github.com/monalisa\",\n    \"followers_url\": \"https://api.github.com/users/monalisa/followers\",\n    \"following_url\": \"https://api.github.com/users/monalisa/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/monalisa/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/monalisa/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/monalisa/orgs\",\n    \"repos_url\": \"https://api.github.com/users/monalisa/repos\",\n    \"events_url\": \"https://api.github.com/users/monalisa/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/monalisa/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": true\n  },\n  \"secret_type\": \"mailchimp_api_key\",\n  \"secret\": \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"\n}\n
" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "State does not match the resolution" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -76238,7 +76570,7 @@ "name": "members", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [ { "parentName": "members", @@ -76347,7 +76679,7 @@ "name": "members", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [ { "parentName": "members", @@ -76548,7 +76880,7 @@ "name": "members", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [ { "parentName": "members", @@ -76657,7 +76989,7 @@ "name": "members", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [ { "parentName": "members", @@ -76765,7 +77097,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "path": { @@ -76773,7 +77105,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "value": { @@ -76790,7 +77122,8 @@ ], "name": "value", "in": "body", - "description": "

undefined

", + "type": "string or object or array", + "description": "", "childParamsGroups": [] } }, @@ -76821,7 +77154,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -76829,7 +77162,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -76846,7 +77179,8 @@ ], "name": "value", "in": "body", - "description": "

undefined

", + "type": "string or object or array", + "description": "", "childParamsGroups": [] } ] @@ -76933,7 +77267,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "path": { @@ -76941,7 +77275,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "value": { @@ -76958,7 +77292,8 @@ ], "name": "value", "in": "body", - "description": "

undefined

", + "type": "string or object or array", + "description": "", "childParamsGroups": [] } }, @@ -76989,7 +77324,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -76997,7 +77332,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -77014,7 +77349,8 @@ ], "name": "value", "in": "body", - "description": "

undefined

", + "type": "string or object or array", + "description": "", "childParamsGroups": [] } ] @@ -77280,7 +77616,7 @@ "name": "name", "in": "body", "rawType": "object", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [ { "parentName": "name", @@ -77401,7 +77737,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -77421,7 +77757,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -77534,7 +77870,7 @@ "name": "name", "in": "body", "rawType": "object", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [ { "parentName": "name", @@ -77655,7 +77991,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -77675,7 +78011,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -77860,7 +78196,7 @@ "name": "name", "in": "body", "rawType": "object", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [ { "parentName": "name", @@ -77981,7 +78317,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -78001,7 +78337,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -78114,7 +78450,7 @@ "name": "name", "in": "body", "rawType": "object", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [ { "parentName": "name", @@ -78235,7 +78571,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -78255,7 +78591,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -78672,7 +79008,7 @@ "name": "givenName", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "familyName": { @@ -78680,7 +79016,7 @@ "name": "familyName", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "formatted": { @@ -78688,7 +79024,7 @@ "name": "formatted", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -78703,7 +79039,7 @@ "name": "name", "in": "body", "rawType": "object", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [ { "parentName": "name", @@ -78715,7 +79051,7 @@ "name": "givenName", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -78723,7 +79059,7 @@ "name": "familyName", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -78731,7 +79067,7 @@ "name": "formatted", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -78760,7 +79096,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "primary": { @@ -78768,7 +79104,7 @@ "name": "primary", "in": "body", "rawType": "boolean", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "type": { @@ -78776,7 +79112,7 @@ "name": "type", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -78799,7 +79135,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -78807,7 +79143,7 @@ "name": "primary", "in": "body", "rawType": "boolean", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -78815,7 +79151,7 @@ "name": "type", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -78830,7 +79166,7 @@ "name": "schemas", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "externalId": { @@ -78838,7 +79174,7 @@ "name": "externalId", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "groups": { @@ -78849,7 +79185,7 @@ "name": "groups", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "active": { @@ -78857,7 +79193,7 @@ "name": "active", "in": "body", "rawType": "boolean", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -78948,7 +79284,7 @@ "name": "givenName", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "familyName": { @@ -78956,7 +79292,7 @@ "name": "familyName", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "formatted": { @@ -78964,7 +79300,7 @@ "name": "formatted", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -78979,7 +79315,7 @@ "name": "name", "in": "body", "rawType": "object", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [ { "parentName": "name", @@ -78991,7 +79327,7 @@ "name": "givenName", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -78999,7 +79335,7 @@ "name": "familyName", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -79007,7 +79343,7 @@ "name": "formatted", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -79036,7 +79372,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "primary": { @@ -79044,7 +79380,7 @@ "name": "primary", "in": "body", "rawType": "boolean", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "type": { @@ -79052,7 +79388,7 @@ "name": "type", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -79075,7 +79411,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -79083,7 +79419,7 @@ "name": "primary", "in": "body", "rawType": "boolean", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -79091,7 +79427,7 @@ "name": "type", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -79106,7 +79442,7 @@ "name": "schemas", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -79114,7 +79450,7 @@ "name": "externalId", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -79125,7 +79461,7 @@ "name": "groups", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -79133,7 +79469,7 @@ "name": "active", "in": "body", "rawType": "boolean", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -79282,7 +79618,7 @@ "name": "schemas", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "displayName": { @@ -79300,7 +79636,7 @@ "name": "externalId", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "groups": { @@ -79311,7 +79647,7 @@ "name": "groups", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "active": { @@ -79319,7 +79655,7 @@ "name": "active", "in": "body", "rawType": "boolean", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "userName": { @@ -79340,7 +79676,7 @@ "name": "givenName", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "familyName": { @@ -79348,7 +79684,7 @@ "name": "familyName", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "formatted": { @@ -79356,7 +79692,7 @@ "name": "formatted", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -79371,7 +79707,7 @@ "name": "name", "in": "body", "rawType": "object", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [ { "parentName": "name", @@ -79383,7 +79719,7 @@ "name": "givenName", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -79391,7 +79727,7 @@ "name": "familyName", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -79399,7 +79735,7 @@ "name": "formatted", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -79428,7 +79764,7 @@ "name": "type", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "value": { @@ -79436,7 +79772,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "primary": { @@ -79444,7 +79780,7 @@ "name": "primary", "in": "body", "rawType": "boolean", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -79467,7 +79803,7 @@ "name": "type", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -79475,7 +79811,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -79483,7 +79819,7 @@ "name": "primary", "in": "body", "rawType": "boolean", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -79543,7 +79879,7 @@ "name": "schemas", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -79561,7 +79897,7 @@ "name": "externalId", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -79572,7 +79908,7 @@ "name": "groups", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -79580,7 +79916,7 @@ "name": "active", "in": "body", "rawType": "boolean", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -79601,7 +79937,7 @@ "name": "givenName", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "familyName": { @@ -79609,7 +79945,7 @@ "name": "familyName", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "formatted": { @@ -79617,7 +79953,7 @@ "name": "formatted", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -79632,7 +79968,7 @@ "name": "name", "in": "body", "rawType": "object", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [ { "parentName": "name", @@ -79644,7 +79980,7 @@ "name": "givenName", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -79652,7 +79988,7 @@ "name": "familyName", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -79660,7 +79996,7 @@ "name": "formatted", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -79689,7 +80025,7 @@ "name": "type", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "value": { @@ -79697,7 +80033,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "primary": { @@ -79705,7 +80041,7 @@ "name": "primary", "in": "body", "rawType": "boolean", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -79728,7 +80064,7 @@ "name": "type", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -79736,7 +80072,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -79744,7 +80080,7 @@ "name": "primary", "in": "body", "rawType": "boolean", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -79813,7 +80149,7 @@ "name": "schemas", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "Operations": { @@ -79841,7 +80177,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "path": { @@ -79849,7 +80185,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "value": { @@ -79899,7 +80235,8 @@ ], "name": "value", "in": "body", - "description": "

undefined

", + "type": "object or array or string", + "description": "", "childParamsGroups": [] } }, @@ -79927,7 +80264,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -79935,7 +80272,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -79985,7 +80322,8 @@ ], "name": "value", "in": "body", - "description": "

undefined

", + "type": "object or array or string", + "description": "", "childParamsGroups": [] } ] @@ -80054,7 +80392,7 @@ "name": "schemas", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -80082,7 +80420,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "path": { @@ -80090,7 +80428,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "value": { @@ -80140,7 +80478,8 @@ ], "name": "value", "in": "body", - "description": "

undefined

", + "type": "object or array or string", + "description": "", "childParamsGroups": [] } }, @@ -80168,7 +80507,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -80176,7 +80515,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -80226,7 +80565,8 @@ ], "name": "value", "in": "body", - "description": "

undefined

", + "type": "object or array or string", + "description": "", "childParamsGroups": [] } ] @@ -81321,7 +81661,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -81406,7 +81746,7 @@ "childParamsGroups": [] }, { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -84767,7 +85107,7 @@ "name": "id", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "name": { @@ -84776,7 +85116,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "description": { @@ -84785,7 +85125,7 @@ "name": "description", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -84838,7 +85178,7 @@ "name": "id", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -84847,7 +85187,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -84856,7 +85196,7 @@ "name": "description", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -84869,7 +85209,7 @@ "name": "synced_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -84965,7 +85305,7 @@ "name": "id", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "name": { @@ -84974,7 +85314,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "description": { @@ -84983,7 +85323,7 @@ "name": "description", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -85036,7 +85376,7 @@ "name": "id", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -85045,7 +85385,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -85054,7 +85394,7 @@ "name": "description", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -85067,7 +85407,7 @@ "name": "synced_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -85304,7 +85644,7 @@ }, "twitter_username": { "description": "

The new Twitter username of the user.

", - "type": "string or null", + "type": "string or nullable", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -85401,7 +85741,7 @@ }, { "description": "

The new Twitter username of the user.

", - "type": "string or null", + "type": "string or nullable", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -86069,14 +86409,19 @@ "type": "object", "properties": { "emails": { - "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "type": "array", + "description": "

Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", + "type": "array of strings", "items": { "type": "string", "example": "username@example.com", "minItems": 1 }, - "example": [] + "example": [], + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "childParamsGroups": [] } }, "required": [ @@ -86118,8 +86463,24 @@ "subcategory": "emails", "subcategoryLabel": "Emails", "notes": [], - "bodyParameters": [], "descriptionHTML": "

This endpoint is accessible with the user scope.

", + "bodyParameters": [ + { + "description": "

Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", + "type": "array of strings", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + }, + "example": [], + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "201", @@ -86191,13 +86552,18 @@ "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "properties": { "emails": { - "description": "Email addresses associated with the GitHub user account.", - "type": "array", + "description": "

Required. Email addresses associated with the GitHub user account.

", + "type": "array of strings", "items": { "type": "string", "example": "username@example.com", "minItems": 1 - } + }, + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Email addresses associated with the GitHub user account.", + "childParamsGroups": [] } }, "example": { @@ -86271,8 +86637,23 @@ "description": "Validation failed" } ], - "bodyParameters": [], - "descriptionHTML": "

This endpoint is accessible with the user scope.

" + "descriptionHTML": "

This endpoint is accessible with the user scope.

", + "bodyParameters": [ + { + "description": "

Required. Email addresses associated with the GitHub user account.

", + "type": "array of strings", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + }, + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Email addresses associated with the GitHub user account.", + "childParamsGroups": [] + } + ] }, { "verb": "get", @@ -88868,7 +89249,7 @@ "name": "repositories", "in": "body", "rawType": "array", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] } }, @@ -88948,7 +89329,7 @@ "name": "repositories", "in": "body", "rawType": "array", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] } ], @@ -90267,7 +90648,7 @@ "body": { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -90317,7 +90698,7 @@ { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", diff --git a/lib/rest/static/decorated/ghes-2.18.json b/lib/rest/static/decorated/ghes-2.18.json index 1ec355d4be50..2037566ff624 100644 --- a/lib/rest/static/decorated/ghes-2.18.json +++ b/lib/rest/static/decorated/ghes-2.18.json @@ -6513,7 +6513,7 @@ "properties": { "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -6599,7 +6599,7 @@ "bodyParameters": [ { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -6752,7 +6752,7 @@ }, "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -6832,7 +6832,7 @@ }, { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -6975,7 +6975,7 @@ }, "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7046,7 +7046,7 @@ }, { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7225,7 +7225,7 @@ "properties": { "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7315,7 +7315,7 @@ "bodyParameters": [ { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -8260,7 +8260,8 @@ ], "name": "public", "in": "body", - "description": "

undefined

", + "description": "

Flag indicating whether the gist is public

", + "type": "boolean or string", "childParamsGroups": [] } }, @@ -8370,7 +8371,8 @@ ], "name": "public", "in": "body", - "description": "

undefined

", + "description": "

Flag indicating whether the gist is public

", + "type": "boolean or string", "childParamsGroups": [] } ] @@ -12020,7 +12022,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -12214,7 +12216,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -12508,7 +12510,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "username": { @@ -12517,7 +12520,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "password": { @@ -12526,7 +12529,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -12587,7 +12590,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -12596,7 +12600,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -12605,7 +12609,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -12748,7 +12752,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "username": { @@ -12757,7 +12762,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "password": { @@ -12766,7 +12771,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -12827,7 +12832,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -12836,7 +12842,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -12845,7 +12851,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -13054,7 +13060,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -13115,7 +13122,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } ] @@ -13153,7 +13161,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -13248,7 +13256,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -13309,7 +13318,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } ] @@ -13347,7 +13357,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -16642,7 +16652,7 @@ "note": { "description": "

The project card's note

", "example": "Update all gems", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "note", "in": "body", @@ -16690,7 +16700,7 @@ { "description": "

The project card's note

", "example": "Update all gems", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "note", "in": "body", @@ -17439,10 +17449,35 @@ "type": "object", "properties": { "note": { - "description": "The project card's note", + "description": "

Required. The project card's note

", "example": "Update all gems", + "type": "string or nullable", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + "content_id": { + "description": "

Required. The unique identifier of the content associated with the card

", + "example": 42, + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] + }, + "content_type": { + "description": "

Required. The piece of content associated with the card

", + "example": "PullRequest", "type": "string", - "nullable": true + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] } }, "required": [ @@ -17453,14 +17488,24 @@ "type": "object", "properties": { "content_id": { - "description": "The unique identifier of the content associated with the card", + "description": "

Required. The unique identifier of the content associated with the card

", "example": 42, - "type": "integer" + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] }, "content_type": { - "description": "The piece of content associated with the card", + "description": "

Required. The piece of content associated with the card

", "example": "PullRequest", - "type": "string" + "type": "string", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] } }, "required": [ @@ -17493,8 +17538,40 @@ "subcategory": "cards", "subcategoryLabel": "Cards", "notes": [], - "bodyParameters": [], "descriptionHTML": "

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

Be 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\" endpoint.

", + "bodyParameters": [ + { + "description": "

Required. The project card's note

", + "example": "Update all gems", + "type": "string or nullable", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + { + "description": "

Required. The unique identifier of the content associated with the card

", + "example": 42, + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] + }, + { + "description": "

Required. The piece of content associated with the card

", + "example": "PullRequest", + "type": "string", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "201", @@ -17790,7 +17867,7 @@ "body": { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -17871,7 +17948,7 @@ { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -20042,7 +20119,7 @@ "type": "object", "properties": { "required_status_checks": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require status checks to pass before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -20108,7 +20185,7 @@ ] }, "enforce_admins": { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "nullable": true, "name": "enforce_admins", @@ -20118,7 +20195,7 @@ "childParamsGroups": [] }, "required_pull_request_reviews": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -20357,7 +20434,7 @@ ] }, "restrictions": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "nullable": true, "properties": { @@ -20462,7 +20539,7 @@ "childParamsGroups": [] }, "allow_force_pushes": { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "nullable": true, "name": "allow_force_pushes", @@ -20577,7 +20654,7 @@ "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Protecting a branch requires admin or owner permissions to the repository.

\n

Note: Passing new arrays of users and teams replaces their previous values.

\n

Note: The list of users, apps, and teams in total is limited to 100 items.

", "bodyParameters": [ { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require status checks to pass before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -20643,7 +20720,7 @@ ] }, { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "nullable": true, "name": "enforce_admins", @@ -20653,7 +20730,7 @@ "childParamsGroups": [] }, { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -20892,7 +20969,7 @@ ] }, { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "nullable": true, "properties": { @@ -20997,7 +21074,7 @@ "childParamsGroups": [] }, { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "nullable": true, "name": "allow_force_pushes", @@ -22575,11 +22652,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -22617,8 +22699,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -22709,11 +22804,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -22751,8 +22851,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -22838,11 +22951,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -22880,8 +22998,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -23219,11 +23350,16 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -23261,8 +23397,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified teams push access for this branch. You can also give push access to child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -23343,11 +23492,16 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -23385,8 +23539,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -23467,11 +23634,16 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -23509,8 +23681,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a team to push to this branch. You can also remove push access for child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayTeams 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -23677,11 +23862,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -23718,8 +23908,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified people push access for this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -23800,11 +24003,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -23841,8 +24049,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -23923,11 +24144,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -23964,8 +24190,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a user to push to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -29235,7 +29474,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -29282,7 +29521,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -31777,7 +32016,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -31819,7 +32058,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -31854,7 +32093,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -31896,7 +32135,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -32045,7 +32284,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -32087,7 +32326,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -32122,7 +32361,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -32164,7 +32403,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -32934,7 +33173,8 @@ ], "name": "payload", "in": "body", - "description": "

undefined

", + "description": "

JSON payload with extra information about the deployment.

", + "type": "object or string", "childParamsGroups": [] }, "environment": { @@ -32948,7 +33188,7 @@ "childParamsGroups": [] }, "description": { - "type": "string or null", + "type": "string or nullable", "description": "

Short description of the deployment.

", "default": "", "nullable": true, @@ -32983,7 +33223,7 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -33038,6 +33278,30 @@ "subcategoryLabel": "Deployments", "notes": [], "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Simple example", + "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
" + }, + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Merged branch response", + "payload": "
{\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
" + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Conflict when there is a merge conflict or the commit's status checks failed" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ], "bodyParameters": [ { "type": "string", @@ -33094,7 +33358,8 @@ ], "name": "payload", "in": "body", - "description": "

undefined

", + "description": "

JSON payload with extra information about the deployment.

", + "type": "object or string", "childParamsGroups": [] }, { @@ -33108,7 +33373,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Short description of the deployment.

", "default": "", "nullable": true, @@ -33143,33 +33408,9 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Simple example", - "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
" - }, - { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "Merged branch response", - "payload": "
{\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
" - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Conflict when there is a merge conflict or the commit's status checks failed" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } ] }, { @@ -34999,7 +35240,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -35054,7 +35295,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -35911,7 +36152,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -35981,7 +36222,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -36115,7 +36356,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -36185,7 +36426,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -36529,7 +36770,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "token": { @@ -36538,7 +36780,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "digest": { @@ -36547,7 +36789,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -36605,7 +36847,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -36614,7 +36857,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -36623,7 +36866,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -36769,7 +37012,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "token": { @@ -36778,7 +37022,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "digest": { @@ -36787,7 +37031,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -36845,7 +37089,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -36854,7 +37099,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -36863,7 +37108,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -37090,7 +37335,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "address": { @@ -37099,7 +37345,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "room": { @@ -37108,7 +37354,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -37169,7 +37415,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -37178,7 +37425,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -37187,7 +37434,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -37335,7 +37582,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "address": { @@ -37344,7 +37592,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "room": { @@ -37353,7 +37601,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -37414,7 +37662,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -37423,7 +37672,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -37432,7 +37681,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -38408,6 +38657,7 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "string or integer", "childParamsGroups": [] }, "body": { @@ -38420,7 +38670,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or null", + "type": "string or nullable", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "nullable": true, "name": "assignee", @@ -38442,12 +38692,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, "labels": { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -38525,6 +38775,39 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "oneOf": [ @@ -38539,6 +38822,7 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "string or integer", "childParamsGroups": [] }, { @@ -38551,7 +38835,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "nullable": true, "name": "assignee", @@ -38573,12 +38857,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -38624,39 +38908,6 @@ "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -39791,11 +40042,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "undefined or null", + "type": "string or integer or nullable", "childParamsGroups": [] }, "body": { - "type": "string or null", + "type": "string or nullable", "description": "

The contents of the issue.

", "nullable": true, "name": "body", @@ -39805,7 +40056,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or null", + "type": "string or nullable", "nullable": true, "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", @@ -39840,12 +40091,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, "labels": { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -39920,6 +40171,44 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

Issue owners and users with push access can edit an issue.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "oneOf": [ @@ -39935,11 +40224,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "undefined or null", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The contents of the issue.

", "nullable": true, "name": "body", @@ -39949,7 +40238,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "nullable": true, "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", @@ -39984,12 +40273,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -40035,44 +40324,6 @@ "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -40871,12 +41122,17 @@ "type": "object", "properties": { "labels": { - "type": "array", + "type": "array of strings", "minItems": 1, - "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "description": "

The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

", "items": { "type": "string" - } + }, + "name": "labels", + "in": "body", + "rawType": "array", + "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "childParamsGroups": [] } } }, @@ -40949,8 +41205,22 @@ "subcategory": "labels", "subcategoryLabel": "Labels", "notes": [], - "bodyParameters": [], "descriptionHTML": "", + "bodyParameters": [ + { + "type": "array of strings", + "minItems": 1, + "description": "

The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

", + "items": { + "type": "string" + }, + "name": "labels", + "in": "body", + "rawType": "array", + "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -46113,7 +46383,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -46217,7 +46487,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -48842,7 +49112,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "side": { @@ -48851,7 +49121,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_line": { @@ -48860,7 +49130,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_side": { @@ -48869,7 +49139,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -48921,7 +49191,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -48930,7 +49200,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -48939,7 +49209,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -48948,7 +49218,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -49077,7 +49347,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "side": { @@ -49086,7 +49356,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_line": { @@ -49095,7 +49365,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_side": { @@ -49104,7 +49374,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -49156,7 +49426,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -49165,7 +49435,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -49174,7 +49444,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -49183,7 +49453,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -49715,7 +49985,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -49756,7 +50026,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -50755,7 +51025,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -50806,7 +51076,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -55599,7 +55869,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.

", "nullable": true, "name": "parent_team_id", @@ -55685,7 +55955,7 @@ "childParamsGroups": [] }, { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.

", "nullable": true, "name": "parent_team_id", @@ -59163,7 +59433,7 @@ }, "twitter_username": { "description": "

The new Twitter username of the user.

", - "type": "string or null", + "type": "string or nullable", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -59260,7 +59530,7 @@ }, { "description": "

The new Twitter username of the user.

", - "type": "string or null", + "type": "string or nullable", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -59470,14 +59740,19 @@ "type": "object", "properties": { "emails": { - "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "type": "array", + "description": "

Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", + "type": "array of strings", "items": { "type": "string", "example": "username@example.com", "minItems": 1 }, - "example": [] + "example": [], + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "childParamsGroups": [] } }, "required": [ @@ -59519,8 +59794,24 @@ "subcategory": "emails", "subcategoryLabel": "Emails", "notes": [], - "bodyParameters": [], "descriptionHTML": "

This endpoint is accessible with the user scope.

", + "bodyParameters": [ + { + "description": "

Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", + "type": "array of strings", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + }, + "example": [], + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "201", @@ -59592,13 +59883,18 @@ "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "properties": { "emails": { - "description": "Email addresses associated with the GitHub user account.", - "type": "array", + "description": "

Required. Email addresses associated with the GitHub user account.

", + "type": "array of strings", "items": { "type": "string", "example": "username@example.com", "minItems": 1 - } + }, + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Email addresses associated with the GitHub user account.", + "childParamsGroups": [] } }, "example": { @@ -59672,8 +59968,23 @@ "description": "Validation failed" } ], - "bodyParameters": [], - "descriptionHTML": "

This endpoint is accessible with the user scope.

" + "descriptionHTML": "

This endpoint is accessible with the user scope.

", + "bodyParameters": [ + { + "description": "

Required. Email addresses associated with the GitHub user account.

", + "type": "array of strings", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + }, + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Email addresses associated with the GitHub user account.", + "childParamsGroups": [] + } + ] }, { "verb": "get", @@ -61856,7 +62167,7 @@ "body": { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -61906,7 +62217,7 @@ { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", diff --git a/lib/rest/static/decorated/ghes-2.19.json b/lib/rest/static/decorated/ghes-2.19.json index c423bd03a44e..1d28280588d8 100644 --- a/lib/rest/static/decorated/ghes-2.19.json +++ b/lib/rest/static/decorated/ghes-2.19.json @@ -6513,7 +6513,7 @@ "properties": { "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -6599,7 +6599,7 @@ "bodyParameters": [ { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -6752,7 +6752,7 @@ }, "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -6832,7 +6832,7 @@ }, { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -6975,7 +6975,7 @@ }, "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7046,7 +7046,7 @@ }, { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7225,7 +7225,7 @@ "properties": { "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7315,7 +7315,7 @@ "bodyParameters": [ { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -8260,7 +8260,8 @@ ], "name": "public", "in": "body", - "description": "

undefined

", + "description": "

Flag indicating whether the gist is public

", + "type": "boolean or string", "childParamsGroups": [] } }, @@ -8370,7 +8371,8 @@ ], "name": "public", "in": "body", - "description": "

undefined

", + "description": "

Flag indicating whether the gist is public

", + "type": "boolean or string", "childParamsGroups": [] } ] @@ -12020,7 +12022,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -12214,7 +12216,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -12508,7 +12510,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "username": { @@ -12517,7 +12520,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "password": { @@ -12526,7 +12529,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -12587,7 +12590,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -12596,7 +12600,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -12605,7 +12609,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -12748,7 +12752,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "username": { @@ -12757,7 +12762,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "password": { @@ -12766,7 +12771,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -12827,7 +12832,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -12836,7 +12842,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -12845,7 +12851,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -13054,7 +13060,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -13115,7 +13122,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } ] @@ -13153,7 +13161,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -13248,7 +13256,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -13309,7 +13318,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } ] @@ -13347,7 +13357,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -16738,7 +16748,7 @@ "note": { "description": "

The project card's note

", "example": "Update all gems", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "note", "in": "body", @@ -16786,7 +16796,7 @@ { "description": "

The project card's note

", "example": "Update all gems", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "note", "in": "body", @@ -17535,10 +17545,35 @@ "type": "object", "properties": { "note": { - "description": "The project card's note", + "description": "

Required. The project card's note

", "example": "Update all gems", + "type": "string or nullable", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + "content_id": { + "description": "

Required. The unique identifier of the content associated with the card

", + "example": 42, + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] + }, + "content_type": { + "description": "

Required. The piece of content associated with the card

", + "example": "PullRequest", "type": "string", - "nullable": true + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] } }, "required": [ @@ -17549,14 +17584,24 @@ "type": "object", "properties": { "content_id": { - "description": "The unique identifier of the content associated with the card", + "description": "

Required. The unique identifier of the content associated with the card

", "example": 42, - "type": "integer" + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] }, "content_type": { - "description": "The piece of content associated with the card", + "description": "

Required. The piece of content associated with the card

", "example": "PullRequest", - "type": "string" + "type": "string", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] } }, "required": [ @@ -17589,8 +17634,40 @@ "subcategory": "cards", "subcategoryLabel": "Cards", "notes": [], - "bodyParameters": [], "descriptionHTML": "

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

Be 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\" endpoint.

", + "bodyParameters": [ + { + "description": "

Required. The project card's note

", + "example": "Update all gems", + "type": "string or nullable", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + { + "description": "

Required. The unique identifier of the content associated with the card

", + "example": 42, + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] + }, + { + "description": "

Required. The piece of content associated with the card

", + "example": "PullRequest", + "type": "string", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "201", @@ -17886,7 +17963,7 @@ "body": { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -17967,7 +18044,7 @@ { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -20130,7 +20207,7 @@ "type": "object", "properties": { "required_status_checks": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require status checks to pass before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -20196,7 +20273,7 @@ ] }, "enforce_admins": { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "nullable": true, "name": "enforce_admins", @@ -20206,7 +20283,7 @@ "childParamsGroups": [] }, "required_pull_request_reviews": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -20445,7 +20522,7 @@ ] }, "restrictions": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "nullable": true, "properties": { @@ -20550,7 +20627,7 @@ "childParamsGroups": [] }, "allow_force_pushes": { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "nullable": true, "name": "allow_force_pushes", @@ -20665,7 +20742,7 @@ "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Protecting a branch requires admin or owner permissions to the repository.

\n

Note: Passing new arrays of users and teams replaces their previous values.

\n

Note: The list of users, apps, and teams in total is limited to 100 items.

", "bodyParameters": [ { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require status checks to pass before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -20731,7 +20808,7 @@ ] }, { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "nullable": true, "name": "enforce_admins", @@ -20741,7 +20818,7 @@ "childParamsGroups": [] }, { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -20980,7 +21057,7 @@ ] }, { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "nullable": true, "properties": { @@ -21085,7 +21162,7 @@ "childParamsGroups": [] }, { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "nullable": true, "name": "allow_force_pushes", @@ -22663,11 +22740,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -22705,8 +22787,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -22797,11 +22892,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -22839,8 +22939,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -22926,11 +23039,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -22968,8 +23086,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -23307,11 +23438,16 @@ "type": "object", "properties": { "apps": { - "type": "array", - "description": "apps parameter", + "type": "array of strings", + "description": "

Required. apps parameter

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } }, "required": [ @@ -23348,131 +23484,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  }\n]\n
" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] - }, - { - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, + "bodyParameters": [ { - "name": "branch", - "description": "The name of the branch.", - "in": "path", - "required": true, - "schema": { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { "type": "string" }, - "x-multi-segment": true, - "descriptionHTML": "

The name of the branch.

" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } ], - "summary": "Set app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", - "tags": [ - "repos" - ], - "operationId": "repos/set-app-access-restrictions", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#set-app-access-restrictions" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "apps parameter", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] - } - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" - }, - "slug": "set-app-access-restrictions", - "category": "repos", - "categoryLabel": "Repos", - "subcategory": "branches", - "subcategoryLabel": "Branches", - "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", "responses": [ { "httpStatusCode": "200", @@ -23488,7 +23514,7 @@ ] }, { - "verb": "delete", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -23525,24 +23551,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Remove app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "summary": "Set app access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", "tags": [ "repos" ], - "operationId": "repos/remove-app-access-restrictions", + "operationId": "repos/set-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#remove-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#set-app-access-restrictions" }, "requestBody": { "content": { @@ -23553,11 +23579,16 @@ "type": "object", "properties": { "apps": { - "type": "array", - "description": "apps parameter", + "type": "array of strings", + "description": "

Required. apps parameter

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } }, "required": [ @@ -23588,14 +23619,27 @@ "category": "repos", "subcategory": "branches" }, - "slug": "remove-app-access-restrictions", + "slug": "set-app-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -23611,8 +23655,8 @@ ] }, { - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { @@ -23648,56 +23692,111 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Get teams with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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.", + "summary": "Remove app access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", "tags": [ "repos" ], - "operationId": "repos/get-teams-with-access-to-protected-branch", + "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#remove-app-access-restrictions" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "apps": { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + } + } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], + "requestBodyParameterName": "apps", "category": "repos", "subcategory": "branches" }, - "slug": "get-teams-with-access-to-the-protected-branch", + "slug": "remove-app-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists the teams who have push access to this branch. The list includes child teams.

", + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
" + "payload": "
[\n  {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  }\n]\n
" }, { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" } ] }, { - "verb": "post", + "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -23734,78 +23833,40 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Add team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "summary": "Get teams with access to the protected branch", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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.", "tags": [ "repos" ], - "operationId": "repos/add-team-access-restrictions", + "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#add-team-access-restrictions" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "teams": { - "type": "array", - "description": "teams parameter", - "items": { - "type": "string" - } - } - }, - "required": [ - "teams" - ], - "example": { - "teams": [ - "my-team" - ] - } - }, - { - "type": "array", - "description": "teams parameter", - "items": { - "type": "string" - } - } - ] - } - } - } + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-teams-with-access-to-the-protected-branch" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "requestBodyParameterName": "teams", "category": "repos", "subcategory": "branches" }, - "slug": "add-team-access-restrictions", + "slug": "get-teams-with-access-to-the-protected-branch", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified teams push access for this branch. You can also give push access to child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists the teams who have push access to this branch. The list includes child teams.

", "responses": [ { "httpStatusCode": "200", @@ -23814,14 +23875,14 @@ "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
" }, { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ] }, { - "verb": "put", + "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -23858,24 +23919,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Set team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "summary": "Add team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", "tags": [ "repos" ], - "operationId": "repos/set-team-access-restrictions", + "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#add-team-access-restrictions" }, "requestBody": { "content": { @@ -23886,11 +23947,16 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -23922,14 +23988,27 @@ "category": "repos", "subcategory": "branches" }, - "slug": "set-team-access-restrictions", + "slug": "add-team-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified teams push access for this branch. You can also give push access to child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -23945,7 +24024,7 @@ ] }, { - "verb": "delete", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -23982,24 +24061,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Remove team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "summary": "Set team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", "tags": [ "repos" ], - "operationId": "repos/remove-team-access-restrictions", + "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#remove-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#set-team-access-restrictions" }, "requestBody": { "content": { @@ -24010,11 +24089,158 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + }, + "required": [ + "teams" + ], + "example": { + "teams": [ + "my-team" + ] + } + }, + { + "type": "array", + "description": "teams parameter", + "items": { + "type": "string" + } + } + ] + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "teams", + "category": "repos", + "subcategory": "branches" + }, + "slug": "set-team-access-restrictions", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "branches", + "subcategoryLabel": "Branches", + "notes": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "branch", + "description": "The name of the branch.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true, + "descriptionHTML": "

The name of the branch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + } + ], + "summary": "Remove team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "tags": [ + "repos" + ], + "operationId": "repos/remove-team-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#remove-team-access-restrictions" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "teams": { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -24052,8 +24278,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a team to push to this branch. You can also remove push access for child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayTeams 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -24220,11 +24459,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -24261,8 +24505,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified people push access for this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -24343,11 +24600,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -24384,8 +24646,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -24466,11 +24741,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -24507,8 +24787,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a user to push to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -29778,7 +30071,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -29825,7 +30118,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -32320,7 +32613,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -32362,7 +32655,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -32397,7 +32690,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -32439,7 +32732,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -32588,7 +32881,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -32630,7 +32923,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -32665,7 +32958,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -32707,7 +33000,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -33477,7 +33770,8 @@ ], "name": "payload", "in": "body", - "description": "

undefined

", + "description": "

JSON payload with extra information about the deployment.

", + "type": "object or string", "childParamsGroups": [] }, "environment": { @@ -33491,7 +33785,7 @@ "childParamsGroups": [] }, "description": { - "type": "string or null", + "type": "string or nullable", "description": "

Short description of the deployment.

", "default": "", "nullable": true, @@ -33526,7 +33820,7 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -33581,6 +33875,30 @@ "subcategoryLabel": "Deployments", "notes": [], "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Simple example", + "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
" + }, + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Merged branch response", + "payload": "
{\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
" + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Conflict when there is a merge conflict or the commit's status checks failed" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ], "bodyParameters": [ { "type": "string", @@ -33637,7 +33955,8 @@ ], "name": "payload", "in": "body", - "description": "

undefined

", + "description": "

JSON payload with extra information about the deployment.

", + "type": "object or string", "childParamsGroups": [] }, { @@ -33651,7 +33970,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Short description of the deployment.

", "default": "", "nullable": true, @@ -33686,33 +34005,9 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Simple example", - "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
" - }, - { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "Merged branch response", - "payload": "
{\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
" - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Conflict when there is a merge conflict or the commit's status checks failed" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } ] }, { @@ -35729,7 +36024,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -35784,7 +36079,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -36552,7 +36847,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -36622,7 +36917,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -36756,7 +37051,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -36826,7 +37121,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -37170,7 +37465,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "token": { @@ -37179,7 +37475,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "digest": { @@ -37188,7 +37484,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -37246,7 +37542,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -37255,7 +37552,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -37264,7 +37561,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -37410,7 +37707,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "token": { @@ -37419,7 +37717,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "digest": { @@ -37428,7 +37726,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -37486,7 +37784,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -37495,7 +37794,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -37504,7 +37803,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -37731,7 +38030,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "address": { @@ -37740,7 +38040,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "room": { @@ -37749,7 +38049,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -37810,7 +38110,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -37819,7 +38120,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -37828,7 +38129,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -37976,7 +38277,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "address": { @@ -37985,7 +38287,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "room": { @@ -37994,7 +38296,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -38055,7 +38357,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -38064,7 +38367,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -38073,7 +38376,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -39049,6 +39352,7 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "string or integer", "childParamsGroups": [] }, "body": { @@ -39061,7 +39365,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or null", + "type": "string or nullable", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "nullable": true, "name": "assignee", @@ -39083,12 +39387,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, "labels": { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -39166,6 +39470,39 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "oneOf": [ @@ -39180,6 +39517,7 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "string or integer", "childParamsGroups": [] }, { @@ -39192,7 +39530,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "nullable": true, "name": "assignee", @@ -39214,12 +39552,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -39265,39 +39603,6 @@ "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -40432,11 +40737,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "undefined or null", + "type": "string or integer or nullable", "childParamsGroups": [] }, "body": { - "type": "string or null", + "type": "string or nullable", "description": "

The contents of the issue.

", "nullable": true, "name": "body", @@ -40446,7 +40751,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or null", + "type": "string or nullable", "nullable": true, "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", @@ -40481,12 +40786,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, "labels": { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -40561,6 +40866,44 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

Issue owners and users with push access can edit an issue.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "oneOf": [ @@ -40576,11 +40919,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "undefined or null", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The contents of the issue.

", "nullable": true, "name": "body", @@ -40590,7 +40933,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "nullable": true, "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", @@ -40625,12 +40968,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -40676,44 +41019,6 @@ "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -41512,12 +41817,17 @@ "type": "object", "properties": { "labels": { - "type": "array", + "type": "array of strings", "minItems": 1, - "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "description": "

The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

", "items": { "type": "string" - } + }, + "name": "labels", + "in": "body", + "rawType": "array", + "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "childParamsGroups": [] } } }, @@ -41590,8 +41900,22 @@ "subcategory": "labels", "subcategoryLabel": "Labels", "notes": [], - "bodyParameters": [], "descriptionHTML": "", + "bodyParameters": [ + { + "type": "array of strings", + "minItems": 1, + "description": "

The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

", + "items": { + "type": "string" + }, + "name": "labels", + "in": "body", + "rawType": "array", + "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -46891,7 +47215,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -46995,7 +47319,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -49620,7 +49944,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "side": { @@ -49629,7 +49953,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_line": { @@ -49638,7 +49962,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_side": { @@ -49647,7 +49971,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -49699,7 +50023,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -49708,7 +50032,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -49717,7 +50041,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -49726,7 +50050,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -49855,7 +50179,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "side": { @@ -49864,7 +50188,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_line": { @@ -49873,7 +50197,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_side": { @@ -49882,7 +50206,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -49934,7 +50258,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -49943,7 +50267,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -49952,7 +50276,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -49961,7 +50285,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -50493,7 +50817,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -50534,7 +50858,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -51533,7 +51857,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -51584,7 +51908,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -56377,7 +56701,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.

", "nullable": true, "name": "parent_team_id", @@ -56463,7 +56787,7 @@ "childParamsGroups": [] }, { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.

", "nullable": true, "name": "parent_team_id", @@ -59729,7 +60053,7 @@ }, "twitter_username": { "description": "

The new Twitter username of the user.

", - "type": "string or null", + "type": "string or nullable", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -59826,7 +60150,7 @@ }, { "description": "

The new Twitter username of the user.

", - "type": "string or null", + "type": "string or nullable", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -60036,14 +60360,19 @@ "type": "object", "properties": { "emails": { - "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "type": "array", + "description": "

Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", + "type": "array of strings", "items": { "type": "string", "example": "username@example.com", "minItems": 1 }, - "example": [] + "example": [], + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "childParamsGroups": [] } }, "required": [ @@ -60085,8 +60414,24 @@ "subcategory": "emails", "subcategoryLabel": "Emails", "notes": [], - "bodyParameters": [], "descriptionHTML": "

This endpoint is accessible with the user scope.

", + "bodyParameters": [ + { + "description": "

Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", + "type": "array of strings", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + }, + "example": [], + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "201", @@ -60158,13 +60503,18 @@ "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "properties": { "emails": { - "description": "Email addresses associated with the GitHub user account.", - "type": "array", + "description": "

Required. Email addresses associated with the GitHub user account.

", + "type": "array of strings", "items": { "type": "string", "example": "username@example.com", "minItems": 1 - } + }, + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Email addresses associated with the GitHub user account.", + "childParamsGroups": [] } }, "example": { @@ -60238,8 +60588,23 @@ "description": "Validation failed" } ], - "bodyParameters": [], - "descriptionHTML": "

This endpoint is accessible with the user scope.

" + "descriptionHTML": "

This endpoint is accessible with the user scope.

", + "bodyParameters": [ + { + "description": "

Required. Email addresses associated with the GitHub user account.

", + "type": "array of strings", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + }, + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Email addresses associated with the GitHub user account.", + "childParamsGroups": [] + } + ] }, { "verb": "get", @@ -62422,7 +62787,7 @@ "body": { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -62472,7 +62837,7 @@ { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", diff --git a/lib/rest/static/decorated/ghes-2.20.json b/lib/rest/static/decorated/ghes-2.20.json index 2fed8b5bfb3c..d25e193ade5f 100644 --- a/lib/rest/static/decorated/ghes-2.20.json +++ b/lib/rest/static/decorated/ghes-2.20.json @@ -6937,7 +6937,7 @@ "properties": { "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7023,7 +7023,7 @@ "bodyParameters": [ { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7176,7 +7176,7 @@ }, "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7256,7 +7256,7 @@ }, { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7399,7 +7399,7 @@ }, "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7470,7 +7470,7 @@ }, { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7649,7 +7649,7 @@ "properties": { "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7739,7 +7739,7 @@ "bodyParameters": [ { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -8684,7 +8684,8 @@ ], "name": "public", "in": "body", - "description": "

undefined

", + "description": "

Flag indicating whether the gist is public

", + "type": "boolean or string", "childParamsGroups": [] } }, @@ -8794,7 +8795,8 @@ ], "name": "public", "in": "body", - "description": "

undefined

", + "description": "

Flag indicating whether the gist is public

", + "type": "boolean or string", "childParamsGroups": [] } ] @@ -12494,7 +12496,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -12688,7 +12690,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -12982,7 +12984,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "username": { @@ -12991,7 +12994,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "password": { @@ -13000,7 +13003,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -13061,7 +13064,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -13070,7 +13074,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -13079,7 +13083,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -13222,7 +13226,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "username": { @@ -13231,7 +13236,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "password": { @@ -13240,7 +13245,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -13301,7 +13306,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -13310,7 +13316,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -13319,7 +13325,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -13528,7 +13534,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -13589,7 +13596,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } ] @@ -13627,7 +13635,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -13722,7 +13730,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -13783,7 +13792,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } ] @@ -13821,7 +13831,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -17212,7 +17222,7 @@ "note": { "description": "

The project card's note

", "example": "Update all gems", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "note", "in": "body", @@ -17260,7 +17270,7 @@ { "description": "

The project card's note

", "example": "Update all gems", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "note", "in": "body", @@ -18009,10 +18019,35 @@ "type": "object", "properties": { "note": { - "description": "The project card's note", + "description": "

Required. The project card's note

", "example": "Update all gems", + "type": "string or nullable", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + "content_id": { + "description": "

Required. The unique identifier of the content associated with the card

", + "example": 42, + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] + }, + "content_type": { + "description": "

Required. The piece of content associated with the card

", + "example": "PullRequest", "type": "string", - "nullable": true + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] } }, "required": [ @@ -18023,14 +18058,24 @@ "type": "object", "properties": { "content_id": { - "description": "The unique identifier of the content associated with the card", + "description": "

Required. The unique identifier of the content associated with the card

", "example": 42, - "type": "integer" + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] }, "content_type": { - "description": "The piece of content associated with the card", + "description": "

Required. The piece of content associated with the card

", "example": "PullRequest", - "type": "string" + "type": "string", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] } }, "required": [ @@ -18063,8 +18108,40 @@ "subcategory": "cards", "subcategoryLabel": "Cards", "notes": [], - "bodyParameters": [], "descriptionHTML": "

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

Be 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\" endpoint.

", + "bodyParameters": [ + { + "description": "

Required. The project card's note

", + "example": "Update all gems", + "type": "string or nullable", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + { + "description": "

Required. The unique identifier of the content associated with the card

", + "example": 42, + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] + }, + { + "description": "

Required. The piece of content associated with the card

", + "example": "PullRequest", + "type": "string", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "201", @@ -18360,7 +18437,7 @@ "body": { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -18441,7 +18518,7 @@ { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -20604,7 +20681,7 @@ "type": "object", "properties": { "required_status_checks": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require status checks to pass before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -20670,7 +20747,7 @@ ] }, "enforce_admins": { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "nullable": true, "name": "enforce_admins", @@ -20680,7 +20757,7 @@ "childParamsGroups": [] }, "required_pull_request_reviews": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -20919,7 +20996,7 @@ ] }, "restrictions": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "nullable": true, "properties": { @@ -21024,7 +21101,7 @@ "childParamsGroups": [] }, "allow_force_pushes": { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "nullable": true, "name": "allow_force_pushes", @@ -21139,7 +21216,7 @@ "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Protecting a branch requires admin or owner permissions to the repository.

\n

Note: Passing new arrays of users and teams replaces their previous values.

\n

Note: The list of users, apps, and teams in total is limited to 100 items.

", "bodyParameters": [ { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require status checks to pass before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -21205,7 +21282,7 @@ ] }, { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "nullable": true, "name": "enforce_admins", @@ -21215,7 +21292,7 @@ "childParamsGroups": [] }, { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -21454,7 +21531,7 @@ ] }, { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "nullable": true, "properties": { @@ -21559,7 +21636,7 @@ "childParamsGroups": [] }, { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "nullable": true, "name": "allow_force_pushes", @@ -23137,11 +23214,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -23179,8 +23261,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -23271,11 +23366,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -23313,8 +23413,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -23400,11 +23513,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -23442,8 +23560,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -23781,11 +23912,16 @@ "type": "object", "properties": { "apps": { - "type": "array", - "description": "apps parameter", + "type": "array of strings", + "description": "

Required. apps parameter

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } }, "required": [ @@ -23822,131 +23958,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  }\n]\n
" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] - }, - { - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, + "bodyParameters": [ { - "name": "branch", - "description": "The name of the branch.", - "in": "path", - "required": true, - "schema": { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { "type": "string" }, - "x-multi-segment": true, - "descriptionHTML": "

The name of the branch.

" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } ], - "summary": "Set app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", - "tags": [ - "repos" - ], - "operationId": "repos/set-app-access-restrictions", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#set-app-access-restrictions" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "apps parameter", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] - } - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" - }, - "slug": "set-app-access-restrictions", - "category": "repos", - "categoryLabel": "Repos", - "subcategory": "branches", - "subcategoryLabel": "Branches", - "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", "responses": [ { "httpStatusCode": "200", @@ -23962,7 +23988,7 @@ ] }, { - "verb": "delete", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -23999,24 +24025,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Remove app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "summary": "Set app access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", "tags": [ "repos" ], - "operationId": "repos/remove-app-access-restrictions", + "operationId": "repos/set-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#remove-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#set-app-access-restrictions" }, "requestBody": { "content": { @@ -24027,11 +24053,16 @@ "type": "object", "properties": { "apps": { - "type": "array", - "description": "apps parameter", + "type": "array of strings", + "description": "

Required. apps parameter

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } }, "required": [ @@ -24062,14 +24093,27 @@ "category": "repos", "subcategory": "branches" }, - "slug": "remove-app-access-restrictions", + "slug": "set-app-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -24085,8 +24129,8 @@ ] }, { - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { @@ -24122,56 +24166,111 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Get teams with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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.", + "summary": "Remove app access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", "tags": [ "repos" ], - "operationId": "repos/get-teams-with-access-to-protected-branch", + "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#list-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#remove-app-access-restrictions" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "apps": { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + } + } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], + "requestBodyParameterName": "apps", "category": "repos", "subcategory": "branches" }, - "slug": "get-teams-with-access-to-the-protected-branch", + "slug": "remove-app-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists the teams who have push access to this branch. The list includes child teams.

", + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
" + "payload": "
[\n  {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  }\n]\n
" }, { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" } ] }, { - "verb": "post", + "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -24208,78 +24307,40 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Add team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "summary": "Get teams with access to the protected branch", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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.", "tags": [ "repos" ], - "operationId": "repos/add-team-access-restrictions", + "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#add-team-access-restrictions" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "teams": { - "type": "array", - "description": "teams parameter", - "items": { - "type": "string" - } - } - }, - "required": [ - "teams" - ], - "example": { - "teams": [ - "my-team" - ] - } - }, - { - "type": "array", - "description": "teams parameter", - "items": { - "type": "string" - } - } - ] - } - } - } + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#list-teams-with-access-to-the-protected-branch" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "requestBodyParameterName": "teams", "category": "repos", "subcategory": "branches" }, - "slug": "add-team-access-restrictions", + "slug": "get-teams-with-access-to-the-protected-branch", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified teams push access for this branch. You can also give push access to child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists the teams who have push access to this branch. The list includes child teams.

", "responses": [ { "httpStatusCode": "200", @@ -24288,14 +24349,14 @@ "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
" }, { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ] }, { - "verb": "put", + "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -24332,24 +24393,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Set team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "summary": "Add team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", "tags": [ "repos" ], - "operationId": "repos/set-team-access-restrictions", + "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#add-team-access-restrictions" }, "requestBody": { "content": { @@ -24360,11 +24421,16 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -24396,14 +24462,27 @@ "category": "repos", "subcategory": "branches" }, - "slug": "set-team-access-restrictions", + "slug": "add-team-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified teams push access for this branch. You can also give push access to child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -24419,7 +24498,7 @@ ] }, { - "verb": "delete", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -24456,24 +24535,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Remove team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "summary": "Set team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", "tags": [ "repos" ], - "operationId": "repos/remove-team-access-restrictions", + "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#remove-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#set-team-access-restrictions" }, "requestBody": { "content": { @@ -24484,11 +24563,158 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + }, + "required": [ + "teams" + ], + "example": { + "teams": [ + "my-team" + ] + } + }, + { + "type": "array", + "description": "teams parameter", + "items": { + "type": "string" + } + } + ] + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "teams", + "category": "repos", + "subcategory": "branches" + }, + "slug": "set-team-access-restrictions", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "branches", + "subcategoryLabel": "Branches", + "notes": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "branch", + "description": "The name of the branch.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true, + "descriptionHTML": "

The name of the branch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + } + ], + "summary": "Remove team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "tags": [ + "repos" + ], + "operationId": "repos/remove-team-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#remove-team-access-restrictions" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "teams": { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -24526,8 +24752,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a team to push to this branch. You can also remove push access for child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayTeams 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -24694,11 +24933,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -24735,8 +24979,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified people push access for this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -24817,11 +25074,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -24858,8 +25120,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -24940,11 +25215,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -24981,8 +25261,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a user to push to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -30252,7 +30545,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -30299,7 +30592,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -32794,7 +33087,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -32836,7 +33129,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -32871,7 +33164,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -32913,7 +33206,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -33062,7 +33355,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -33104,7 +33397,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -33139,7 +33432,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -33181,7 +33474,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -33951,7 +34244,8 @@ ], "name": "payload", "in": "body", - "description": "

undefined

", + "description": "

JSON payload with extra information about the deployment.

", + "type": "object or string", "childParamsGroups": [] }, "environment": { @@ -33965,7 +34259,7 @@ "childParamsGroups": [] }, "description": { - "type": "string or null", + "type": "string or nullable", "description": "

Short description of the deployment.

", "default": "", "nullable": true, @@ -34000,7 +34294,7 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -34055,6 +34349,30 @@ "subcategoryLabel": "Deployments", "notes": [], "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Simple example", + "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
" + }, + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Merged branch response", + "payload": "
{\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
" + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Conflict when there is a merge conflict or the commit's status checks failed" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ], "bodyParameters": [ { "type": "string", @@ -34111,7 +34429,8 @@ ], "name": "payload", "in": "body", - "description": "

undefined

", + "description": "

JSON payload with extra information about the deployment.

", + "type": "object or string", "childParamsGroups": [] }, { @@ -34125,7 +34444,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Short description of the deployment.

", "default": "", "nullable": true, @@ -34160,33 +34479,9 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Simple example", - "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
" - }, - { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "Merged branch response", - "payload": "
{\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
" - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Conflict when there is a merge conflict or the commit's status checks failed" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } ] }, { @@ -36203,7 +36498,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -36258,7 +36553,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -37026,7 +37321,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -37096,7 +37391,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -37230,7 +37525,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -37300,7 +37595,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -37644,7 +37939,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "token": { @@ -37653,7 +37949,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "digest": { @@ -37662,7 +37958,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -37720,7 +38016,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -37729,7 +38026,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -37738,7 +38035,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -37884,7 +38181,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "token": { @@ -37893,7 +38191,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "digest": { @@ -37902,7 +38200,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -37960,7 +38258,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -37969,7 +38268,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -37978,7 +38277,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -38205,7 +38504,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "address": { @@ -38214,7 +38514,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "room": { @@ -38223,7 +38523,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -38284,7 +38584,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -38293,7 +38594,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -38302,7 +38603,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -38450,7 +38751,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "address": { @@ -38459,7 +38761,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "room": { @@ -38468,7 +38770,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -38529,7 +38831,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -38538,7 +38841,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -38547,7 +38850,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -39523,6 +39826,7 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "string or integer", "childParamsGroups": [] }, "body": { @@ -39535,7 +39839,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or null", + "type": "string or nullable", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "nullable": true, "name": "assignee", @@ -39557,12 +39861,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, "labels": { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -39640,6 +39944,39 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "oneOf": [ @@ -39654,6 +39991,7 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "string or integer", "childParamsGroups": [] }, { @@ -39666,7 +40004,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "nullable": true, "name": "assignee", @@ -39688,12 +40026,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -39739,39 +40077,6 @@ "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -40906,11 +41211,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "undefined or null", + "type": "string or integer or nullable", "childParamsGroups": [] }, "body": { - "type": "string or null", + "type": "string or nullable", "description": "

The contents of the issue.

", "nullable": true, "name": "body", @@ -40920,7 +41225,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or null", + "type": "string or nullable", "nullable": true, "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", @@ -40955,12 +41260,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, "labels": { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -41035,6 +41340,44 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

Issue owners and users with push access can edit an issue.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "oneOf": [ @@ -41050,11 +41393,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "undefined or null", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The contents of the issue.

", "nullable": true, "name": "body", @@ -41064,7 +41407,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "nullable": true, "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", @@ -41099,12 +41442,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -41150,44 +41493,6 @@ "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -41986,12 +42291,17 @@ "type": "object", "properties": { "labels": { - "type": "array", + "type": "array of strings", "minItems": 1, - "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "description": "

The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

", "items": { "type": "string" - } + }, + "name": "labels", + "in": "body", + "rawType": "array", + "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "childParamsGroups": [] } } }, @@ -42064,8 +42374,22 @@ "subcategory": "labels", "subcategoryLabel": "Labels", "notes": [], - "bodyParameters": [], "descriptionHTML": "", + "bodyParameters": [ + { + "type": "array of strings", + "minItems": 1, + "description": "

The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

", + "items": { + "type": "string" + }, + "name": "labels", + "in": "body", + "rawType": "array", + "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -47365,7 +47689,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -47469,7 +47793,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -48836,7 +49160,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -48981,7 +49305,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -50276,7 +50600,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "side": { @@ -50285,7 +50609,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_line": { @@ -50294,7 +50618,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_side": { @@ -50303,7 +50627,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -50355,7 +50679,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -50364,7 +50688,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -50373,7 +50697,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -50382,7 +50706,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -50511,7 +50835,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "side": { @@ -50520,7 +50844,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_line": { @@ -50529,7 +50853,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_side": { @@ -50538,7 +50862,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -50590,7 +50914,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -50599,7 +50923,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -50608,7 +50932,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -50617,7 +50941,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -51149,7 +51473,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -51190,7 +51514,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -52189,7 +52513,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -52240,7 +52564,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -57025,7 +57349,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -57103,7 +57427,7 @@ "childParamsGroups": [] }, { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -60291,7 +60615,7 @@ }, "twitter_username": { "description": "

The new Twitter username of the user.

", - "type": "string or null", + "type": "string or nullable", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -60388,7 +60712,7 @@ }, { "description": "

The new Twitter username of the user.

", - "type": "string or null", + "type": "string or nullable", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -60598,14 +60922,19 @@ "type": "object", "properties": { "emails": { - "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "type": "array", + "description": "

Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", + "type": "array of strings", "items": { "type": "string", "example": "username@example.com", "minItems": 1 }, - "example": [] + "example": [], + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "childParamsGroups": [] } }, "required": [ @@ -60647,8 +60976,24 @@ "subcategory": "emails", "subcategoryLabel": "Emails", "notes": [], - "bodyParameters": [], "descriptionHTML": "

This endpoint is accessible with the user scope.

", + "bodyParameters": [ + { + "description": "

Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", + "type": "array of strings", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + }, + "example": [], + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "201", @@ -60720,13 +61065,18 @@ "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "properties": { "emails": { - "description": "Email addresses associated with the GitHub user account.", - "type": "array", + "description": "

Required. Email addresses associated with the GitHub user account.

", + "type": "array of strings", "items": { "type": "string", "example": "username@example.com", "minItems": 1 - } + }, + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Email addresses associated with the GitHub user account.", + "childParamsGroups": [] } }, "example": { @@ -60800,8 +61150,23 @@ "description": "Validation failed" } ], - "bodyParameters": [], - "descriptionHTML": "

This endpoint is accessible with the user scope.

" + "descriptionHTML": "

This endpoint is accessible with the user scope.

", + "bodyParameters": [ + { + "description": "

Required. Email addresses associated with the GitHub user account.

", + "type": "array of strings", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + }, + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Email addresses associated with the GitHub user account.", + "childParamsGroups": [] + } + ] }, { "verb": "get", @@ -62984,7 +63349,7 @@ "body": { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -63034,7 +63399,7 @@ { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", diff --git a/lib/rest/static/decorated/ghes-2.21.json b/lib/rest/static/decorated/ghes-2.21.json index 0d16d4839466..585cab7c2ac6 100644 --- a/lib/rest/static/decorated/ghes-2.21.json +++ b/lib/rest/static/decorated/ghes-2.21.json @@ -6931,7 +6931,7 @@ "properties": { "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7017,7 +7017,7 @@ "bodyParameters": [ { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7170,7 +7170,7 @@ }, "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7250,7 +7250,7 @@ }, { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7393,7 +7393,7 @@ }, "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7464,7 +7464,7 @@ }, { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7643,7 +7643,7 @@ "properties": { "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7733,7 +7733,7 @@ "bodyParameters": [ { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -8678,7 +8678,8 @@ ], "name": "public", "in": "body", - "description": "

undefined

", + "description": "

Flag indicating whether the gist is public

", + "type": "boolean or string", "childParamsGroups": [] } }, @@ -8788,7 +8789,8 @@ ], "name": "public", "in": "body", - "description": "

undefined

", + "description": "

Flag indicating whether the gist is public

", + "type": "boolean or string", "childParamsGroups": [] } ] @@ -12488,7 +12490,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -12682,7 +12684,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -12976,7 +12978,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "username": { @@ -12985,7 +12988,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "password": { @@ -12994,7 +12997,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -13055,7 +13058,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -13064,7 +13068,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -13073,7 +13077,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -13216,7 +13220,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "username": { @@ -13225,7 +13230,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "password": { @@ -13234,7 +13239,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -13295,7 +13300,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -13304,7 +13310,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -13313,7 +13319,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -13522,7 +13528,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -13583,7 +13590,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } ] @@ -13621,7 +13629,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -13716,7 +13724,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -13777,7 +13786,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } ] @@ -13815,7 +13825,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -17170,7 +17180,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -17249,7 +17259,7 @@ "childParamsGroups": [] }, { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -20664,7 +20674,7 @@ "note": { "description": "

The project card's note

", "example": "Update all gems", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "note", "in": "body", @@ -20712,7 +20722,7 @@ { "description": "

The project card's note

", "example": "Update all gems", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "note", "in": "body", @@ -21461,10 +21471,35 @@ "type": "object", "properties": { "note": { - "description": "The project card's note", + "description": "

Required. The project card's note

", "example": "Update all gems", + "type": "string or nullable", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + "content_id": { + "description": "

Required. The unique identifier of the content associated with the card

", + "example": 42, + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] + }, + "content_type": { + "description": "

Required. The piece of content associated with the card

", + "example": "PullRequest", "type": "string", - "nullable": true + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] } }, "required": [ @@ -21475,14 +21510,24 @@ "type": "object", "properties": { "content_id": { - "description": "The unique identifier of the content associated with the card", + "description": "

Required. The unique identifier of the content associated with the card

", "example": 42, - "type": "integer" + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] }, "content_type": { - "description": "The piece of content associated with the card", + "description": "

Required. The piece of content associated with the card

", "example": "PullRequest", - "type": "string" + "type": "string", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] } }, "required": [ @@ -21515,8 +21560,40 @@ "subcategory": "cards", "subcategoryLabel": "Cards", "notes": [], - "bodyParameters": [], "descriptionHTML": "

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

Be 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\" endpoint.

", + "bodyParameters": [ + { + "description": "

Required. The project card's note

", + "example": "Update all gems", + "type": "string or nullable", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + { + "description": "

Required. The unique identifier of the content associated with the card

", + "example": 42, + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] + }, + { + "description": "

Required. The piece of content associated with the card

", + "example": "PullRequest", + "type": "string", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "201", @@ -21812,7 +21889,7 @@ "body": { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -21893,7 +21970,7 @@ { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -24075,7 +24152,7 @@ "type": "object", "properties": { "required_status_checks": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require status checks to pass before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -24141,7 +24218,7 @@ ] }, "enforce_admins": { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "nullable": true, "name": "enforce_admins", @@ -24151,7 +24228,7 @@ "childParamsGroups": [] }, "required_pull_request_reviews": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -24390,7 +24467,7 @@ ] }, "restrictions": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "nullable": true, "properties": { @@ -24495,7 +24572,7 @@ "childParamsGroups": [] }, "allow_force_pushes": { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "nullable": true, "name": "allow_force_pushes", @@ -24610,7 +24687,7 @@ "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Protecting a branch requires admin or owner permissions to the repository.

\n

Note: Passing new arrays of users and teams replaces their previous values.

\n

Note: The list of users, apps, and teams in total is limited to 100 items.

", "bodyParameters": [ { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require status checks to pass before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -24676,7 +24753,7 @@ ] }, { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "nullable": true, "name": "enforce_admins", @@ -24686,7 +24763,7 @@ "childParamsGroups": [] }, { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -24925,7 +25002,7 @@ ] }, { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "nullable": true, "properties": { @@ -25030,7 +25107,7 @@ "childParamsGroups": [] }, { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "nullable": true, "name": "allow_force_pushes", @@ -26608,11 +26685,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -26650,8 +26732,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -26742,11 +26837,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -26784,8 +26884,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -26871,11 +26984,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -26913,8 +27031,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -27252,11 +27383,16 @@ "type": "object", "properties": { "apps": { - "type": "array", - "description": "apps parameter", + "type": "array of strings", + "description": "

Required. apps parameter

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } }, "required": [ @@ -27293,131 +27429,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  }\n]\n
" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] - }, - { - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, + "bodyParameters": [ { - "name": "branch", - "description": "The name of the branch.", - "in": "path", - "required": true, - "schema": { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { "type": "string" }, - "x-multi-segment": true, - "descriptionHTML": "

The name of the branch.

" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } ], - "summary": "Set app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", - "tags": [ - "repos" - ], - "operationId": "repos/set-app-access-restrictions", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#set-app-access-restrictions" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "apps parameter", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] - } - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" - }, - "slug": "set-app-access-restrictions", - "category": "repos", - "categoryLabel": "Repos", - "subcategory": "branches", - "subcategoryLabel": "Branches", - "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", "responses": [ { "httpStatusCode": "200", @@ -27433,7 +27459,7 @@ ] }, { - "verb": "delete", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -27470,24 +27496,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Remove app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "summary": "Set app access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", "tags": [ "repos" ], - "operationId": "repos/remove-app-access-restrictions", + "operationId": "repos/set-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#remove-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#set-app-access-restrictions" }, "requestBody": { "content": { @@ -27498,11 +27524,16 @@ "type": "object", "properties": { "apps": { - "type": "array", - "description": "apps parameter", + "type": "array of strings", + "description": "

Required. apps parameter

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } }, "required": [ @@ -27533,14 +27564,27 @@ "category": "repos", "subcategory": "branches" }, - "slug": "remove-app-access-restrictions", + "slug": "set-app-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -27556,8 +27600,8 @@ ] }, { - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { @@ -27593,56 +27637,111 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Get teams with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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.", + "summary": "Remove app access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", "tags": [ "repos" ], - "operationId": "repos/get-teams-with-access-to-protected-branch", + "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#list-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#remove-app-access-restrictions" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "apps": { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + } + } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], + "requestBodyParameterName": "apps", "category": "repos", "subcategory": "branches" }, - "slug": "get-teams-with-access-to-the-protected-branch", + "slug": "remove-app-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists the teams who have push access to this branch. The list includes child teams.

", + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
" + "payload": "
[\n  {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  }\n]\n
" }, { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" } ] }, { - "verb": "post", + "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -27679,78 +27778,40 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Add team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "summary": "Get teams with access to the protected branch", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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.", "tags": [ "repos" ], - "operationId": "repos/add-team-access-restrictions", + "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#add-team-access-restrictions" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "teams": { - "type": "array", - "description": "teams parameter", - "items": { - "type": "string" - } - } - }, - "required": [ - "teams" - ], - "example": { - "teams": [ - "my-team" - ] - } - }, - { - "type": "array", - "description": "teams parameter", - "items": { - "type": "string" - } - } - ] - } - } - } + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#list-teams-with-access-to-the-protected-branch" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "requestBodyParameterName": "teams", "category": "repos", "subcategory": "branches" }, - "slug": "add-team-access-restrictions", + "slug": "get-teams-with-access-to-the-protected-branch", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified teams push access for this branch. You can also give push access to child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists the teams who have push access to this branch. The list includes child teams.

", "responses": [ { "httpStatusCode": "200", @@ -27759,14 +27820,14 @@ "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
" }, { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ] }, { - "verb": "put", + "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -27803,24 +27864,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Set team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "summary": "Add team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", "tags": [ "repos" ], - "operationId": "repos/set-team-access-restrictions", + "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#add-team-access-restrictions" }, "requestBody": { "content": { @@ -27831,11 +27892,16 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -27867,14 +27933,27 @@ "category": "repos", "subcategory": "branches" }, - "slug": "set-team-access-restrictions", + "slug": "add-team-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified teams push access for this branch. You can also give push access to child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -27890,7 +27969,7 @@ ] }, { - "verb": "delete", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -27927,24 +28006,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Remove team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "summary": "Set team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", "tags": [ "repos" ], - "operationId": "repos/remove-team-access-restrictions", + "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#remove-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#set-team-access-restrictions" }, "requestBody": { "content": { @@ -27955,11 +28034,158 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + }, + "required": [ + "teams" + ], + "example": { + "teams": [ + "my-team" + ] + } + }, + { + "type": "array", + "description": "teams parameter", + "items": { + "type": "string" + } + } + ] + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "teams", + "category": "repos", + "subcategory": "branches" + }, + "slug": "set-team-access-restrictions", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "branches", + "subcategoryLabel": "Branches", + "notes": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "branch", + "description": "The name of the branch.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true, + "descriptionHTML": "

The name of the branch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + } + ], + "summary": "Remove team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "tags": [ + "repos" + ], + "operationId": "repos/remove-team-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#remove-team-access-restrictions" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "teams": { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -27997,8 +28223,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a team to push to this branch. You can also remove push access for child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayTeams 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -28165,11 +28404,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -28206,8 +28450,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified people push access for this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -28288,11 +28545,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -28329,8 +28591,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -28411,11 +28686,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -28452,8 +28732,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a user to push to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -33723,7 +34016,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -33770,7 +34063,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -36358,7 +36651,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -36400,7 +36693,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -36435,7 +36728,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -36477,7 +36770,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -36626,7 +36919,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -36668,7 +36961,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -36703,7 +36996,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -36745,7 +37038,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -37515,7 +37808,8 @@ ], "name": "payload", "in": "body", - "description": "

undefined

", + "description": "

JSON payload with extra information about the deployment.

", + "type": "object or string", "childParamsGroups": [] }, "environment": { @@ -37529,7 +37823,7 @@ "childParamsGroups": [] }, "description": { - "type": "string or null", + "type": "string or nullable", "description": "

Short description of the deployment.

", "default": "", "nullable": true, @@ -37564,7 +37858,7 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -37619,6 +37913,30 @@ "subcategoryLabel": "Deployments", "notes": [], "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Simple example", + "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
" + }, + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Merged branch response", + "payload": "
{\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
" + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Conflict when there is a merge conflict or the commit's status checks failed" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ], "bodyParameters": [ { "type": "string", @@ -37675,7 +37993,8 @@ ], "name": "payload", "in": "body", - "description": "

undefined

", + "description": "

JSON payload with extra information about the deployment.

", + "type": "object or string", "childParamsGroups": [] }, { @@ -37689,7 +38008,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Short description of the deployment.

", "default": "", "nullable": true, @@ -37724,33 +38043,9 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Simple example", - "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
" - }, - { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "Merged branch response", - "payload": "
{\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
" - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Conflict when there is a merge conflict or the commit's status checks failed" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } ] }, { @@ -39994,7 +40289,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -40049,7 +40344,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -40817,7 +41112,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -40887,7 +41182,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -41021,7 +41316,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -41091,7 +41386,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -41435,7 +41730,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "token": { @@ -41444,7 +41740,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "digest": { @@ -41453,7 +41749,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -41511,7 +41807,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -41520,7 +41817,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -41529,7 +41826,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -41675,7 +41972,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "token": { @@ -41684,7 +41982,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "digest": { @@ -41693,7 +41991,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -41751,7 +42049,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -41760,7 +42059,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -41769,7 +42068,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -41996,7 +42295,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "address": { @@ -42005,7 +42305,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "room": { @@ -42014,7 +42314,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -42075,7 +42375,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -42084,7 +42385,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -42093,7 +42394,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -42241,7 +42542,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "address": { @@ -42250,7 +42552,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "room": { @@ -42259,7 +42561,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -42320,7 +42622,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -42329,7 +42632,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -42338,7 +42641,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -43314,6 +43617,7 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "string or integer", "childParamsGroups": [] }, "body": { @@ -43326,7 +43630,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or null", + "type": "string or nullable", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "nullable": true, "name": "assignee", @@ -43348,12 +43652,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, "labels": { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -43431,6 +43735,39 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "oneOf": [ @@ -43445,6 +43782,7 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "string or integer", "childParamsGroups": [] }, { @@ -43457,7 +43795,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "nullable": true, "name": "assignee", @@ -43479,12 +43817,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -43530,39 +43868,6 @@ "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -44790,11 +45095,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "undefined or null", + "type": "string or integer or nullable", "childParamsGroups": [] }, "body": { - "type": "string or null", + "type": "string or nullable", "description": "

The contents of the issue.

", "nullable": true, "name": "body", @@ -44804,7 +45109,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or null", + "type": "string or nullable", "nullable": true, "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", @@ -44839,12 +45144,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, "labels": { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -44919,6 +45224,44 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

Issue owners and users with push access can edit an issue.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "oneOf": [ @@ -44934,11 +45277,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "undefined or null", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The contents of the issue.

", "nullable": true, "name": "body", @@ -44948,7 +45291,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "nullable": true, "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", @@ -44983,12 +45326,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -45034,44 +45377,6 @@ "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -45870,12 +46175,17 @@ "type": "object", "properties": { "labels": { - "type": "array", + "type": "array of strings", "minItems": 1, - "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "description": "

The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

", "items": { "type": "string" - } + }, + "name": "labels", + "in": "body", + "rawType": "array", + "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "childParamsGroups": [] } } }, @@ -45948,8 +46258,22 @@ "subcategory": "labels", "subcategoryLabel": "Labels", "notes": [], - "bodyParameters": [], "descriptionHTML": "", + "bodyParameters": [ + { + "type": "array of strings", + "minItems": 1, + "description": "

The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

", + "items": { + "type": "string" + }, + "name": "labels", + "in": "body", + "rawType": "array", + "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -51336,7 +51660,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -51434,7 +51758,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -52888,7 +53212,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -53033,7 +53357,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -54330,7 +54654,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "side": { @@ -54339,7 +54663,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_line": { @@ -54348,7 +54672,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_side": { @@ -54357,7 +54681,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -54409,7 +54733,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -54418,7 +54742,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -54427,7 +54751,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -54436,7 +54760,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -54565,7 +54889,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "side": { @@ -54574,7 +54898,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_line": { @@ -54583,7 +54907,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_side": { @@ -54592,7 +54916,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -54644,7 +54968,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -54653,7 +54977,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -54662,7 +54986,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -54671,7 +54995,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -55203,7 +55527,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -55244,7 +55568,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -56243,7 +56567,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -56294,7 +56618,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -61088,7 +61412,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -61173,7 +61497,7 @@ "childParamsGroups": [] }, { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -64526,7 +64850,7 @@ }, "twitter_username": { "description": "

The new Twitter username of the user.

", - "type": "string or null", + "type": "string or nullable", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -64623,7 +64947,7 @@ }, { "description": "

The new Twitter username of the user.

", - "type": "string or null", + "type": "string or nullable", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -64833,14 +65157,19 @@ "type": "object", "properties": { "emails": { - "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "type": "array", + "description": "

Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", + "type": "array of strings", "items": { "type": "string", "example": "username@example.com", "minItems": 1 }, - "example": [] + "example": [], + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "childParamsGroups": [] } }, "required": [ @@ -64882,8 +65211,24 @@ "subcategory": "emails", "subcategoryLabel": "Emails", "notes": [], - "bodyParameters": [], "descriptionHTML": "

This endpoint is accessible with the user scope.

", + "bodyParameters": [ + { + "description": "

Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", + "type": "array of strings", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + }, + "example": [], + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "201", @@ -64955,13 +65300,18 @@ "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "properties": { "emails": { - "description": "Email addresses associated with the GitHub user account.", - "type": "array", + "description": "

Required. Email addresses associated with the GitHub user account.

", + "type": "array of strings", "items": { "type": "string", "example": "username@example.com", "minItems": 1 - } + }, + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Email addresses associated with the GitHub user account.", + "childParamsGroups": [] } }, "example": { @@ -65035,8 +65385,23 @@ "description": "Validation failed" } ], - "bodyParameters": [], - "descriptionHTML": "

This endpoint is accessible with the user scope.

" + "descriptionHTML": "

This endpoint is accessible with the user scope.

", + "bodyParameters": [ + { + "description": "

Required. Email addresses associated with the GitHub user account.

", + "type": "array of strings", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + }, + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Email addresses associated with the GitHub user account.", + "childParamsGroups": [] + } + ] }, { "verb": "get", @@ -67219,7 +67584,7 @@ "body": { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -67269,7 +67634,7 @@ { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", diff --git a/lib/rest/static/decorated/ghes-2.22.json b/lib/rest/static/decorated/ghes-2.22.json index 83e5b31408bf..65ad3f00f859 100644 --- a/lib/rest/static/decorated/ghes-2.22.json +++ b/lib/rest/static/decorated/ghes-2.22.json @@ -7005,7 +7005,7 @@ "properties": { "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7091,7 +7091,7 @@ "bodyParameters": [ { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7244,7 +7244,7 @@ }, "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7324,7 +7324,7 @@ }, { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7467,7 +7467,7 @@ }, "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7538,7 +7538,7 @@ }, { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7717,7 +7717,7 @@ "properties": { "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -7807,7 +7807,7 @@ "bodyParameters": [ { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -10451,7 +10451,8 @@ ], "name": "public", "in": "body", - "description": "

undefined

", + "description": "

Flag indicating whether the gist is public

", + "type": "boolean or string", "childParamsGroups": [] } }, @@ -10561,7 +10562,8 @@ ], "name": "public", "in": "body", - "description": "

undefined

", + "description": "

Flag indicating whether the gist is public

", + "type": "boolean or string", "childParamsGroups": [] } ] @@ -14245,7 +14247,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -14439,7 +14441,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -17257,7 +17259,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "username": { @@ -17266,7 +17269,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "password": { @@ -17275,7 +17278,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -17336,7 +17339,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -17345,7 +17349,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -17354,7 +17358,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -17497,7 +17501,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "username": { @@ -17506,7 +17511,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "password": { @@ -17515,7 +17520,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -17576,7 +17581,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -17585,7 +17591,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -17594,7 +17600,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -17803,7 +17809,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -17864,7 +17871,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } ] @@ -17902,7 +17910,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -17997,7 +18005,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -18058,7 +18067,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } ] @@ -18096,7 +18106,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -21418,7 +21428,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -21497,7 +21507,7 @@ "childParamsGroups": [] }, { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -24912,7 +24922,7 @@ "note": { "description": "

The project card's note

", "example": "Update all gems", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "note", "in": "body", @@ -24960,7 +24970,7 @@ { "description": "

The project card's note

", "example": "Update all gems", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "note", "in": "body", @@ -25709,10 +25719,35 @@ "type": "object", "properties": { "note": { - "description": "The project card's note", + "description": "

Required. The project card's note

", "example": "Update all gems", + "type": "string or nullable", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + "content_id": { + "description": "

Required. The unique identifier of the content associated with the card

", + "example": 42, + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] + }, + "content_type": { + "description": "

Required. The piece of content associated with the card

", + "example": "PullRequest", "type": "string", - "nullable": true + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] } }, "required": [ @@ -25723,14 +25758,24 @@ "type": "object", "properties": { "content_id": { - "description": "The unique identifier of the content associated with the card", + "description": "

Required. The unique identifier of the content associated with the card

", "example": 42, - "type": "integer" + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] }, "content_type": { - "description": "The piece of content associated with the card", + "description": "

Required. The piece of content associated with the card

", "example": "PullRequest", - "type": "string" + "type": "string", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] } }, "required": [ @@ -25763,8 +25808,40 @@ "subcategory": "cards", "subcategoryLabel": "Cards", "notes": [], - "bodyParameters": [], "descriptionHTML": "

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

Be 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\" endpoint.

", + "bodyParameters": [ + { + "description": "

Required. The project card's note

", + "example": "Update all gems", + "type": "string or nullable", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + { + "description": "

Required. The unique identifier of the content associated with the card

", + "example": 42, + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] + }, + { + "description": "

Required. The piece of content associated with the card

", + "example": "PullRequest", + "type": "string", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "201", @@ -26060,7 +26137,7 @@ "body": { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -26141,7 +26218,7 @@ { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -31061,7 +31138,7 @@ "type": "object", "properties": { "required_status_checks": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require status checks to pass before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -31127,7 +31204,7 @@ ] }, "enforce_admins": { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "nullable": true, "name": "enforce_admins", @@ -31137,7 +31214,7 @@ "childParamsGroups": [] }, "required_pull_request_reviews": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -31376,7 +31453,7 @@ ] }, "restrictions": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "nullable": true, "properties": { @@ -31481,7 +31558,7 @@ "childParamsGroups": [] }, "allow_force_pushes": { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "nullable": true, "name": "allow_force_pushes", @@ -31596,7 +31673,7 @@ "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Protecting a branch requires admin or owner permissions to the repository.

\n

Note: Passing new arrays of users and teams replaces their previous values.

\n

Note: The list of users, apps, and teams in total is limited to 100 items.

", "bodyParameters": [ { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require status checks to pass before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -31662,7 +31739,7 @@ ] }, { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "nullable": true, "name": "enforce_admins", @@ -31672,7 +31749,7 @@ "childParamsGroups": [] }, { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -31911,7 +31988,7 @@ ] }, { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "nullable": true, "properties": { @@ -32016,7 +32093,7 @@ "childParamsGroups": [] }, { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "nullable": true, "name": "allow_force_pushes", @@ -33594,11 +33671,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -33636,8 +33718,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -33728,11 +33823,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -33770,8 +33870,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -33857,11 +33970,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -33899,8 +34017,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -34238,11 +34369,16 @@ "type": "object", "properties": { "apps": { - "type": "array", - "description": "apps parameter", + "type": "array of strings", + "description": "

Required. apps parameter

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } }, "required": [ @@ -34279,131 +34415,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  }\n]\n
" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] - }, - { - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, + "bodyParameters": [ { - "name": "branch", - "description": "The name of the branch.", - "in": "path", - "required": true, - "schema": { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { "type": "string" }, - "x-multi-segment": true, - "descriptionHTML": "

The name of the branch.

" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } ], - "summary": "Set app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", - "tags": [ - "repos" - ], - "operationId": "repos/set-app-access-restrictions", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#set-app-access-restrictions" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "apps parameter", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] - } - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "requestBodyParameterName": "apps", - "category": "repos", - "subcategory": "branches" - }, - "slug": "set-app-access-restrictions", - "category": "repos", - "categoryLabel": "Repos", - "subcategory": "branches", - "subcategoryLabel": "Branches", - "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", "responses": [ { "httpStatusCode": "200", @@ -34419,7 +34445,7 @@ ] }, { - "verb": "delete", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -34456,24 +34482,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Remove app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "summary": "Set app access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", "tags": [ "repos" ], - "operationId": "repos/remove-app-access-restrictions", + "operationId": "repos/set-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#remove-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#set-app-access-restrictions" }, "requestBody": { "content": { @@ -34484,11 +34510,16 @@ "type": "object", "properties": { "apps": { - "type": "array", - "description": "apps parameter", + "type": "array of strings", + "description": "

Required. apps parameter

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } }, "required": [ @@ -34519,14 +34550,27 @@ "category": "repos", "subcategory": "branches" }, - "slug": "remove-app-access-restrictions", + "slug": "set-app-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -34542,8 +34586,8 @@ ] }, { - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { @@ -34579,56 +34623,111 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Get teams with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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.", + "summary": "Remove app access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", "tags": [ "repos" ], - "operationId": "repos/get-teams-with-access-to-protected-branch", + "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#list-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#remove-app-access-restrictions" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "apps": { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + } + } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], + "requestBodyParameterName": "apps", "category": "repos", "subcategory": "branches" }, - "slug": "get-teams-with-access-to-the-protected-branch", + "slug": "remove-app-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists the teams who have push access to this branch. The list includes child teams.

", + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
" + "payload": "
[\n  {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  }\n]\n
" }, { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" } ] }, { - "verb": "post", + "verb": "get", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -34665,78 +34764,40 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Add team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "summary": "Get teams with access to the protected branch", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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.", "tags": [ "repos" ], - "operationId": "repos/add-team-access-restrictions", + "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#add-team-access-restrictions" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "teams": { - "type": "array", - "description": "teams parameter", - "items": { - "type": "string" - } - } - }, - "required": [ - "teams" - ], - "example": { - "teams": [ - "my-team" - ] - } - }, - { - "type": "array", - "description": "teams parameter", - "items": { - "type": "string" - } - } - ] - } - } - } + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#list-teams-with-access-to-the-protected-branch" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "requestBodyParameterName": "teams", "category": "repos", "subcategory": "branches" }, - "slug": "add-team-access-restrictions", + "slug": "get-teams-with-access-to-the-protected-branch", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified teams push access for this branch. You can also give push access to child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists the teams who have push access to this branch. The list includes child teams.

", "responses": [ { "httpStatusCode": "200", @@ -34745,14 +34806,14 @@ "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
" }, { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ] }, { - "verb": "put", + "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -34789,24 +34850,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Set team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "summary": "Add team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", "tags": [ "repos" ], - "operationId": "repos/set-team-access-restrictions", + "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#add-team-access-restrictions" }, "requestBody": { "content": { @@ -34817,11 +34878,16 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -34853,14 +34919,27 @@ "category": "repos", "subcategory": "branches" }, - "slug": "set-team-access-restrictions", + "slug": "add-team-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified teams push access for this branch. You can also give push access to child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -34876,7 +34955,7 @@ ] }, { - "verb": "delete", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -34913,24 +34992,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], - "summary": "Remove team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "summary": "Set team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", "tags": [ "repos" ], - "operationId": "repos/remove-team-access-restrictions", + "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#remove-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#set-team-access-restrictions" }, "requestBody": { "content": { @@ -34941,11 +35020,158 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + }, + "required": [ + "teams" + ], + "example": { + "teams": [ + "my-team" + ] + } + }, + { + "type": "array", + "description": "teams parameter", + "items": { + "type": "string" + } + } + ] + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "teams", + "category": "repos", + "subcategory": "branches" + }, + "slug": "set-team-access-restrictions", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "branches", + "subcategoryLabel": "Branches", + "notes": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "branch", + "description": "The name of the branch.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true, + "descriptionHTML": "

The name of the branch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" + } + ], + "summary": "Remove team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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. |", + "tags": [ + "repos" + ], + "operationId": "repos/remove-team-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#remove-team-access-restrictions" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "teams": { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -34983,8 +35209,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a team to push to this branch. You can also remove push access for child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayTeams 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -35151,11 +35390,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -35192,8 +35436,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified people push access for this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -35274,11 +35531,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -35315,8 +35577,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -35397,11 +35672,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -35438,8 +35718,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a user to push to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -40760,7 +41053,7 @@ "childParamsGroups": [] }, "dismissed_reason": { - "type": "string or null", + "type": "string or nullable", "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "nullable": true, "oneOf": [ @@ -40806,6 +41099,29 @@ "categoryLabel": "Code scanning", "notes": [], "descriptionHTML": "

Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "description": "

Required. Sets the state of the code scanning alert. Can be one of open or dismissed. You must provide dismissed_reason when you set the state to dismissed.

", @@ -40821,7 +41137,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "nullable": true, "oneOf": [ @@ -40844,29 +41160,6 @@ "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -41530,7 +41823,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -41577,7 +41870,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -44165,7 +44458,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -44207,7 +44500,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -44242,7 +44535,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -44284,7 +44577,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -44433,7 +44726,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -44475,7 +44768,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -44510,7 +44803,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -44552,7 +44845,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -45322,7 +45615,8 @@ ], "name": "payload", "in": "body", - "description": "

undefined

", + "description": "

JSON payload with extra information about the deployment.

", + "type": "object or string", "childParamsGroups": [] }, "environment": { @@ -45336,7 +45630,7 @@ "childParamsGroups": [] }, "description": { - "type": "string or null", + "type": "string or nullable", "description": "

Short description of the deployment.

", "default": "", "nullable": true, @@ -45371,7 +45665,7 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -45426,6 +45720,30 @@ "subcategoryLabel": "Deployments", "notes": [], "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Simple example", + "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
" + }, + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Merged branch response", + "payload": "
{\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
" + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Conflict when there is a merge conflict or the commit's status checks failed" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ], "bodyParameters": [ { "type": "string", @@ -45482,7 +45800,8 @@ ], "name": "payload", "in": "body", - "description": "

undefined

", + "description": "

JSON payload with extra information about the deployment.

", + "type": "object or string", "childParamsGroups": [] }, { @@ -45496,7 +45815,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Short description of the deployment.

", "default": "", "nullable": true, @@ -45531,33 +45850,9 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Simple example", - "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
" - }, - { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "Merged branch response", - "payload": "
{\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
" - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Conflict when there is a merge conflict or the commit's status checks failed" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } ] }, { @@ -47789,7 +48084,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -47844,7 +48139,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -48612,7 +48907,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -48682,7 +48977,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -48816,7 +49111,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -48886,7 +49181,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -49230,7 +49525,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "token": { @@ -49239,7 +49535,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "digest": { @@ -49248,7 +49544,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -49306,7 +49602,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -49315,7 +49612,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -49324,7 +49621,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -49470,7 +49767,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "token": { @@ -49479,7 +49777,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "digest": { @@ -49488,7 +49786,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -49546,7 +49844,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -49555,7 +49854,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -49564,7 +49863,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -49791,7 +50090,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "address": { @@ -49800,7 +50100,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "room": { @@ -49809,7 +50109,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -49870,7 +50170,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -49879,7 +50180,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -49888,7 +50189,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -50036,7 +50337,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "address": { @@ -50045,7 +50347,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "room": { @@ -50054,7 +50356,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -50115,7 +50417,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -50124,7 +50427,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -50133,7 +50436,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -51093,6 +51396,7 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "string or integer", "childParamsGroups": [] }, "body": { @@ -51105,7 +51409,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or null", + "type": "string or nullable", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "nullable": true, "name": "assignee", @@ -51127,12 +51431,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, "labels": { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -51210,6 +51514,39 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "oneOf": [ @@ -51224,6 +51561,7 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "string or integer", "childParamsGroups": [] }, { @@ -51236,7 +51574,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "nullable": true, "name": "assignee", @@ -51258,12 +51596,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -51309,39 +51647,6 @@ "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -52551,11 +52856,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "undefined or null", + "type": "string or integer or nullable", "childParamsGroups": [] }, "body": { - "type": "string or null", + "type": "string or nullable", "description": "

The contents of the issue.

", "nullable": true, "name": "body", @@ -52565,7 +52870,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or null", + "type": "string or nullable", "nullable": true, "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", @@ -52600,12 +52905,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, "labels": { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -52680,6 +52985,44 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

Issue owners and users with push access can edit an issue.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "oneOf": [ @@ -52695,11 +53038,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "undefined or null", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The contents of the issue.

", "nullable": true, "name": "body", @@ -52709,7 +53052,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "nullable": true, "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", @@ -52744,12 +53087,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -52795,44 +53138,6 @@ "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -53625,12 +53930,17 @@ "type": "object", "properties": { "labels": { - "type": "array", + "type": "array of strings", "minItems": 1, - "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "description": "

The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

", "items": { "type": "string" - } + }, + "name": "labels", + "in": "body", + "rawType": "array", + "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "childParamsGroups": [] } } }, @@ -53703,8 +54013,22 @@ "subcategory": "labels", "subcategoryLabel": "Labels", "notes": [], - "bodyParameters": [], "descriptionHTML": "", + "bodyParameters": [ + { + "type": "array of strings", + "minItems": 1, + "description": "

The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

", + "items": { + "type": "string" + }, + "name": "labels", + "in": "body", + "rawType": "array", + "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -57474,7 +57798,7 @@ "type": "object", "properties": { "cname": { - "type": "string or null", + "type": "string or nullable", "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

", "nullable": true, "name": "cname", @@ -57537,7 +57861,8 @@ ], "name": "source", "in": "body", - "description": "

undefined

", + "type": "", + "description": "", "childParamsGroups": [] } }, @@ -57607,7 +57932,7 @@ "descriptionHTML": "

Updates information for a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.

", "bodyParameters": [ { - "type": "string or null", + "type": "string or nullable", "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

", "nullable": true, "name": "cname", @@ -57670,7 +57995,8 @@ ], "name": "source", "in": "body", - "description": "

undefined

", + "type": "", + "description": "", "childParamsGroups": [] } ] @@ -59071,7 +59397,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -59163,7 +59489,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -60611,7 +60937,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -60756,7 +61082,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -62053,7 +62379,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "side": { @@ -62062,7 +62388,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_line": { @@ -62071,7 +62397,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_side": { @@ -62080,7 +62406,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -62132,7 +62458,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -62141,7 +62467,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -62150,7 +62476,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -62159,7 +62485,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -62288,7 +62614,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "side": { @@ -62297,7 +62623,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_line": { @@ -62306,7 +62632,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_side": { @@ -62315,7 +62641,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -62367,7 +62693,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -62376,7 +62702,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -62385,7 +62711,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -62394,7 +62720,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -62926,7 +63252,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -62967,7 +63293,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -63966,7 +64292,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -64017,7 +64343,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -68811,7 +69137,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -68896,7 +69222,7 @@ "childParamsGroups": [] }, { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -72249,7 +72575,7 @@ }, "twitter_username": { "description": "

The new Twitter username of the user.

", - "type": "string or null", + "type": "string or nullable", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -72346,7 +72672,7 @@ }, { "description": "

The new Twitter username of the user.

", - "type": "string or null", + "type": "string or nullable", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -72556,14 +72882,19 @@ "type": "object", "properties": { "emails": { - "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "type": "array", + "description": "

Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", + "type": "array of strings", "items": { "type": "string", "example": "username@example.com", "minItems": 1 }, - "example": [] + "example": [], + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "childParamsGroups": [] } }, "required": [ @@ -72605,8 +72936,24 @@ "subcategory": "emails", "subcategoryLabel": "Emails", "notes": [], - "bodyParameters": [], "descriptionHTML": "

This endpoint is accessible with the user scope.

", + "bodyParameters": [ + { + "description": "

Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", + "type": "array of strings", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + }, + "example": [], + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "201", @@ -72678,13 +73025,18 @@ "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "properties": { "emails": { - "description": "Email addresses associated with the GitHub user account.", - "type": "array", + "description": "

Required. Email addresses associated with the GitHub user account.

", + "type": "array of strings", "items": { "type": "string", "example": "username@example.com", "minItems": 1 - } + }, + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Email addresses associated with the GitHub user account.", + "childParamsGroups": [] } }, "example": { @@ -72758,8 +73110,23 @@ "description": "Validation failed" } ], - "bodyParameters": [], - "descriptionHTML": "

This endpoint is accessible with the user scope.

" + "descriptionHTML": "

This endpoint is accessible with the user scope.

", + "bodyParameters": [ + { + "description": "

Required. Email addresses associated with the GitHub user account.

", + "type": "array of strings", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + }, + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Email addresses associated with the GitHub user account.", + "childParamsGroups": [] + } + ] }, { "verb": "get", @@ -74894,7 +75261,7 @@ "body": { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -74944,7 +75311,7 @@ { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json index f88dc05109fa..b4b8627b9266 100644 --- a/lib/rest/static/decorated/ghes-3.0.json +++ b/lib/rest/static/decorated/ghes-3.0.json @@ -3846,7 +3846,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -3874,6 +3875,14 @@ "subcategoryLabel": "Webhooks", "notes": [], "descriptionHTML": "

Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"

\n

You must use a JWT to access this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" + } + ], "bodyParameters": [ { "type": "string", @@ -3919,17 +3928,10 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" - } ] }, { @@ -9040,7 +9042,7 @@ "properties": { "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -9126,7 +9128,7 @@ "bodyParameters": [ { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -9279,7 +9281,7 @@ }, "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -9359,7 +9361,7 @@ }, { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -9502,7 +9504,7 @@ }, "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -9573,7 +9575,7 @@ }, { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -9752,7 +9754,7 @@ "properties": { "scopes": { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -9842,7 +9844,7 @@ "bodyParameters": [ { "description": "

A list of scopes that this authorization is in.

", - "type": "array of strings or null", + "type": "array of strings or nullable", "items": { "type": "string" }, @@ -10456,7 +10458,7 @@ "childParamsGroups": [] }, "expires_at": { - "type": "string or null", + "type": "string or nullable", "description": "

The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

", "example": "\"2021-01-01T00:00:00.000-07:00\"", "nullable": true, @@ -10500,7 +10502,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

", "example": "\"2021-01-01T00:00:00.000-07:00\"", "nullable": true, @@ -13420,7 +13422,8 @@ ], "name": "public", "in": "body", - "description": "

undefined

", + "description": "

Flag indicating whether the gist is public

", + "type": "boolean or string", "childParamsGroups": [] } }, @@ -13530,7 +13533,8 @@ ], "name": "public", "in": "body", - "description": "

undefined

", + "description": "

Flag indicating whether the gist is public

", + "type": "boolean or string", "childParamsGroups": [] } ] @@ -17224,7 +17228,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -17428,7 +17432,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -20959,7 +20963,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "username": { @@ -20968,7 +20973,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "password": { @@ -20977,7 +20982,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -21038,7 +21043,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -21047,7 +21053,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -21056,7 +21062,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -21199,7 +21205,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "username": { @@ -21208,7 +21215,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "password": { @@ -21217,7 +21224,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -21278,7 +21285,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -21287,7 +21295,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -21296,7 +21304,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -21505,7 +21513,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -21566,7 +21575,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } ] @@ -21604,7 +21614,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -21699,7 +21709,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -21760,7 +21771,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } ] @@ -21798,7 +21810,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -22043,7 +22055,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -22072,6 +22085,14 @@ "subcategoryLabel": "Webhooks", "notes": [], "descriptionHTML": "

Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"

\n

Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:write permission.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" + } + ], "bodyParameters": [ { "type": "string", @@ -22117,17 +22138,10 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" - } ] }, { @@ -25373,7 +25387,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -25452,7 +25466,7 @@ "childParamsGroups": [] }, { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -28867,7 +28881,7 @@ "note": { "description": "

The project card's note

", "example": "Update all gems", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "note", "in": "body", @@ -28915,7 +28929,7 @@ { "description": "

The project card's note

", "example": "Update all gems", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "note", "in": "body", @@ -29664,10 +29678,35 @@ "type": "object", "properties": { "note": { - "description": "The project card's note", + "description": "

Required. The project card's note

", "example": "Update all gems", + "type": "string or nullable", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + "content_id": { + "description": "

Required. The unique identifier of the content associated with the card

", + "example": 42, + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] + }, + "content_type": { + "description": "

Required. The piece of content associated with the card

", + "example": "PullRequest", "type": "string", - "nullable": true + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] } }, "required": [ @@ -29678,14 +29717,24 @@ "type": "object", "properties": { "content_id": { - "description": "The unique identifier of the content associated with the card", + "description": "

Required. The unique identifier of the content associated with the card

", "example": 42, - "type": "integer" + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] }, "content_type": { - "description": "The piece of content associated with the card", + "description": "

Required. The piece of content associated with the card

", "example": "PullRequest", - "type": "string" + "type": "string", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] } }, "required": [ @@ -29718,8 +29767,40 @@ "subcategory": "cards", "subcategoryLabel": "Cards", "notes": [], - "bodyParameters": [], "descriptionHTML": "

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

Be 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\" endpoint.

", + "bodyParameters": [ + { + "description": "

Required. The project card's note

", + "example": "Update all gems", + "type": "string or nullable", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + { + "description": "

Required. The unique identifier of the content associated with the card

", + "example": 42, + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] + }, + { + "description": "

Required. The piece of content associated with the card

", + "example": "PullRequest", + "type": "string", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "201", @@ -30015,7 +30096,7 @@ "body": { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -30096,7 +30177,7 @@ { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -35601,7 +35682,7 @@ "type": "object", "properties": { "required_status_checks": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require status checks to pass before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -35667,7 +35748,7 @@ ] }, "enforce_admins": { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "nullable": true, "name": "enforce_admins", @@ -35677,7 +35758,7 @@ "childParamsGroups": [] }, "required_pull_request_reviews": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -35916,7 +35997,7 @@ ] }, "restrictions": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "nullable": true, "properties": { @@ -36021,7 +36102,7 @@ "childParamsGroups": [] }, "allow_force_pushes": { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "nullable": true, "name": "allow_force_pushes", @@ -36136,7 +36217,7 @@ "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Protecting a branch requires admin or owner permissions to the repository.

\n

Note: Passing new arrays of users and teams replaces their previous values.

\n

Note: The list of users, apps, and teams in total is limited to 100 items.

", "bodyParameters": [ { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require status checks to pass before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -36202,7 +36283,7 @@ ] }, { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "nullable": true, "name": "enforce_admins", @@ -36212,7 +36293,7 @@ "childParamsGroups": [] }, { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -36451,7 +36532,7 @@ ] }, { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "nullable": true, "properties": { @@ -36556,7 +36637,7 @@ "childParamsGroups": [] }, { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "nullable": true, "name": "allow_force_pushes", @@ -38134,11 +38215,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -38176,8 +38262,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -38268,11 +38367,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -38310,8 +38414,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -38397,11 +38514,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -38439,8 +38561,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -38778,11 +38913,16 @@ "type": "object", "properties": { "apps": { - "type": "array", - "description": "apps parameter", + "type": "array of strings", + "description": "

Required. apps parameter

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } }, "required": [ @@ -38819,8 +38959,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -38901,11 +39054,16 @@ "type": "object", "properties": { "apps": { - "type": "array", - "description": "apps parameter", + "type": "array of strings", + "description": "

Required. apps parameter

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } }, "required": [ @@ -38942,8 +39100,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -39024,11 +39195,16 @@ "type": "object", "properties": { "apps": { - "type": "array", - "description": "apps parameter", + "type": "array of strings", + "description": "

Required. apps parameter

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } }, "required": [ @@ -39065,8 +39241,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -39233,11 +39422,16 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -39275,8 +39469,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified teams push access for this branch. You can also give push access to child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -39357,11 +39564,16 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -39399,8 +39611,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -39481,11 +39706,16 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -39523,8 +39753,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a team to push to this branch. You can also remove push access for child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayTeams 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -39691,11 +39934,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -39732,8 +39980,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified people push access for this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -39814,11 +40075,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -39855,8 +40121,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -39937,11 +40216,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -39978,8 +40262,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a user to push to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -45237,7 +45534,7 @@ "childParamsGroups": [] }, "dismissed_reason": { - "type": "string or null", + "type": "string or nullable", "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "nullable": true, "oneOf": [ @@ -45283,6 +45580,29 @@ "categoryLabel": "Code scanning", "notes": [], "descriptionHTML": "

Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if the repository is archived or if github advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "description": "

Required. Sets the state of the code scanning alert. Can be one of open or dismissed. You must provide dismissed_reason when you set the state to dismissed.

", @@ -45298,7 +45618,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "nullable": true, "oneOf": [ @@ -45321,29 +45641,6 @@ "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -46007,7 +46304,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -46054,7 +46351,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -48628,7 +48925,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -48670,7 +48967,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -48705,7 +49002,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -48747,7 +49044,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -48896,7 +49193,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -48938,7 +49235,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -48973,7 +49270,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -49015,7 +49312,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -49785,7 +50082,8 @@ ], "name": "payload", "in": "body", - "description": "

undefined

", + "description": "

JSON payload with extra information about the deployment.

", + "type": "object or string", "childParamsGroups": [] }, "environment": { @@ -49799,7 +50097,7 @@ "childParamsGroups": [] }, "description": { - "type": "string or null", + "type": "string or nullable", "description": "

Short description of the deployment.

", "default": "", "nullable": true, @@ -49834,7 +50132,7 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -49889,6 +50187,30 @@ "subcategoryLabel": "Deployments", "notes": [], "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Simple example", + "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
" + }, + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Merged branch response", + "payload": "
{\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
" + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Conflict when there is a merge conflict or the commit's status checks failed" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ], "bodyParameters": [ { "type": "string", @@ -49945,7 +50267,8 @@ ], "name": "payload", "in": "body", - "description": "

undefined

", + "description": "

JSON payload with extra information about the deployment.

", + "type": "object or string", "childParamsGroups": [] }, { @@ -49959,7 +50282,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Short description of the deployment.

", "default": "", "nullable": true, @@ -49994,33 +50317,9 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Simple example", - "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
" - }, - { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "Merged branch response", - "payload": "
{\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
" - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Conflict when there is a merge conflict or the commit's status checks failed" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } ] }, { @@ -52252,7 +52551,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -52307,7 +52606,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -53075,7 +53374,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -53145,7 +53444,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -53279,7 +53578,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -53349,7 +53648,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -53693,7 +53992,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "token": { @@ -53702,7 +54002,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "digest": { @@ -53711,7 +54011,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -53769,7 +54069,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -53778,7 +54079,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -53787,7 +54088,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -53933,7 +54234,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "token": { @@ -53942,7 +54244,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "digest": { @@ -53951,7 +54253,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -54009,7 +54311,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -54018,7 +54321,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -54027,7 +54330,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -54254,7 +54557,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "address": { @@ -54263,7 +54567,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "room": { @@ -54272,7 +54576,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -54333,7 +54637,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -54342,7 +54647,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -54351,7 +54656,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -54499,7 +54804,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "address": { @@ -54508,7 +54814,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "room": { @@ -54517,7 +54823,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -54578,7 +54884,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -54587,7 +54894,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -54596,7 +54903,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -54922,7 +55229,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -54950,6 +55258,14 @@ "subcategoryLabel": "Webhooks", "notes": [], "descriptionHTML": "

Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"

\n

Access tokens must have the write:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:write permission.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" + } + ], "bodyParameters": [ { "type": "string", @@ -54995,17 +55311,10 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" - } ] }, { @@ -55827,6 +56136,7 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "string or integer", "childParamsGroups": [] }, "body": { @@ -55839,7 +56149,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or null", + "type": "string or nullable", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "nullable": true, "name": "assignee", @@ -55861,12 +56171,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, "labels": { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -55944,6 +56254,39 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "oneOf": [ @@ -55958,6 +56301,7 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "string or integer", "childParamsGroups": [] }, { @@ -55970,7 +56314,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "nullable": true, "name": "assignee", @@ -55992,12 +56336,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -56043,39 +56387,6 @@ "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -57285,11 +57596,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "undefined or null", + "type": "string or integer or nullable", "childParamsGroups": [] }, "body": { - "type": "string or null", + "type": "string or nullable", "description": "

The contents of the issue.

", "nullable": true, "name": "body", @@ -57299,7 +57610,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or null", + "type": "string or nullable", "nullable": true, "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", @@ -57334,12 +57645,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, "labels": { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -57414,6 +57725,44 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

Issue owners and users with push access can edit an issue.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "oneOf": [ @@ -57429,11 +57778,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "undefined or null", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The contents of the issue.

", "nullable": true, "name": "body", @@ -57443,7 +57792,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "nullable": true, "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", @@ -57478,12 +57827,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -57529,44 +57878,6 @@ "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -58359,12 +58670,17 @@ "type": "object", "properties": { "labels": { - "type": "array", + "type": "array of strings", "minItems": 1, - "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "description": "

The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

", "items": { "type": "string" - } + }, + "name": "labels", + "in": "body", + "rawType": "array", + "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "childParamsGroups": [] } } }, @@ -58437,8 +58753,22 @@ "subcategory": "labels", "subcategoryLabel": "Labels", "notes": [], - "bodyParameters": [], "descriptionHTML": "", + "bodyParameters": [ + { + "type": "array of strings", + "minItems": 1, + "description": "

The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

", + "items": { + "type": "string" + }, + "name": "labels", + "in": "body", + "rawType": "array", + "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -62208,7 +62538,7 @@ "type": "object", "properties": { "cname": { - "type": "string or null", + "type": "string or nullable", "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

", "nullable": true, "name": "cname", @@ -62271,7 +62601,8 @@ ], "name": "source", "in": "body", - "description": "

undefined

", + "type": "", + "description": "", "childParamsGroups": [] } }, @@ -62341,7 +62672,7 @@ "descriptionHTML": "

Updates information for a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.

", "bodyParameters": [ { - "type": "string or null", + "type": "string or nullable", "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

", "nullable": true, "name": "cname", @@ -62404,7 +62735,8 @@ ], "name": "source", "in": "body", - "description": "

undefined

", + "type": "", + "description": "", "childParamsGroups": [] } ] @@ -63805,7 +64137,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -63897,7 +64229,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -65345,7 +65677,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -65490,7 +65822,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -66787,7 +67119,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "side": { @@ -66796,7 +67128,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_line": { @@ -66805,7 +67137,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_side": { @@ -66814,7 +67146,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -66866,7 +67198,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -66875,7 +67207,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -66884,7 +67216,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -66893,7 +67225,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -67022,7 +67354,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "side": { @@ -67031,7 +67363,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_line": { @@ -67040,7 +67372,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_side": { @@ -67049,7 +67381,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -67101,7 +67433,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -67110,7 +67442,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -67119,7 +67451,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -67128,7 +67460,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -67660,7 +67992,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -67701,7 +68033,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -68700,7 +69032,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -68751,7 +69083,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -73545,7 +73877,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -73630,7 +73962,7 @@ "childParamsGroups": [] }, { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -76983,7 +77315,7 @@ }, "twitter_username": { "description": "

The new Twitter username of the user.

", - "type": "string or null", + "type": "string or nullable", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -77080,7 +77412,7 @@ }, { "description": "

The new Twitter username of the user.

", - "type": "string or null", + "type": "string or nullable", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -77290,14 +77622,19 @@ "type": "object", "properties": { "emails": { - "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "type": "array", + "description": "

Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", + "type": "array of strings", "items": { "type": "string", "example": "username@example.com", "minItems": 1 }, - "example": [] + "example": [], + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "childParamsGroups": [] } }, "required": [ @@ -77339,8 +77676,24 @@ "subcategory": "emails", "subcategoryLabel": "Emails", "notes": [], - "bodyParameters": [], "descriptionHTML": "

This endpoint is accessible with the user scope.

", + "bodyParameters": [ + { + "description": "

Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

", + "type": "array of strings", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + }, + "example": [], + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "201", @@ -77412,13 +77765,18 @@ "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "properties": { "emails": { - "description": "Email addresses associated with the GitHub user account.", - "type": "array", + "description": "

Required. Email addresses associated with the GitHub user account.

", + "type": "array of strings", "items": { "type": "string", "example": "username@example.com", "minItems": 1 - } + }, + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Email addresses associated with the GitHub user account.", + "childParamsGroups": [] } }, "example": { @@ -77492,8 +77850,23 @@ "description": "Validation failed" } ], - "bodyParameters": [], - "descriptionHTML": "

This endpoint is accessible with the user scope.

" + "descriptionHTML": "

This endpoint is accessible with the user scope.

", + "bodyParameters": [ + { + "description": "

Required. Email addresses associated with the GitHub user account.

", + "type": "array of strings", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + }, + "name": "emails", + "in": "body", + "rawType": "array", + "rawDescription": "Email addresses associated with the GitHub user account.", + "childParamsGroups": [] + } + ] }, { "verb": "get", @@ -79628,7 +80001,7 @@ "body": { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -79678,7 +80051,7 @@ { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 4945d97d291f..7ebd0bb8be98 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -2674,7 +2674,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -2702,6 +2703,14 @@ "subcategoryLabel": "Webhooks", "notes": [], "descriptionHTML": "

Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"

\n

You must use a JWT to access this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" + } + ], "bodyParameters": [ { "type": "string", @@ -2747,17 +2756,10 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" - } ] }, { @@ -6106,7 +6108,7 @@ "childParamsGroups": [] }, "expires_at": { - "type": "string or null", + "type": "string or nullable", "description": "

The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

", "example": "\"2021-01-01T00:00:00.000-07:00\"", "nullable": true, @@ -6150,7 +6152,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

", "example": "\"2021-01-01T00:00:00.000-07:00\"", "nullable": true, @@ -8782,7 +8784,8 @@ ], "name": "public", "in": "body", - "description": "

undefined

", + "description": "

Flag indicating whether the gist is public

", + "type": "boolean or string", "childParamsGroups": [] } }, @@ -8892,7 +8895,8 @@ ], "name": "public", "in": "body", - "description": "

undefined

", + "description": "

Flag indicating whether the gist is public

", + "type": "boolean or string", "childParamsGroups": [] } ] @@ -12606,7 +12610,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -12830,7 +12834,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -15154,7 +15158,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "username": { @@ -15163,7 +15168,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "password": { @@ -15172,7 +15177,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -15233,7 +15238,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -15242,7 +15248,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -15251,7 +15257,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -15394,7 +15400,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "username": { @@ -15403,7 +15410,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "password": { @@ -15412,7 +15419,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -15473,7 +15480,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -15482,7 +15490,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -15491,7 +15499,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -15700,7 +15708,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -15761,7 +15770,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } ] @@ -15799,7 +15809,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -15894,7 +15904,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -15955,7 +15966,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } ] @@ -15993,7 +16005,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -16238,7 +16250,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -16267,6 +16280,14 @@ "subcategoryLabel": "Webhooks", "notes": [], "descriptionHTML": "

Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"

\n

Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:write permission.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" + } + ], "bodyParameters": [ { "type": "string", @@ -16312,17 +16333,10 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" - } ] }, { @@ -19166,7 +19180,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -19245,7 +19259,7 @@ "childParamsGroups": [] }, { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -22660,7 +22674,7 @@ "note": { "description": "

The project card's note

", "example": "Update all gems", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "note", "in": "body", @@ -22708,7 +22722,7 @@ { "description": "

The project card's note

", "example": "Update all gems", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "note", "in": "body", @@ -23457,10 +23471,35 @@ "type": "object", "properties": { "note": { - "description": "The project card's note", + "description": "

Required. The project card's note

", "example": "Update all gems", + "type": "string or nullable", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + "content_id": { + "description": "

Required. The unique identifier of the content associated with the card

", + "example": 42, + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] + }, + "content_type": { + "description": "

Required. The piece of content associated with the card

", + "example": "PullRequest", "type": "string", - "nullable": true + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] } }, "required": [ @@ -23471,14 +23510,24 @@ "type": "object", "properties": { "content_id": { - "description": "The unique identifier of the content associated with the card", + "description": "

Required. The unique identifier of the content associated with the card

", "example": 42, - "type": "integer" + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] }, "content_type": { - "description": "The piece of content associated with the card", + "description": "

Required. The piece of content associated with the card

", "example": "PullRequest", - "type": "string" + "type": "string", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] } }, "required": [ @@ -23511,8 +23560,40 @@ "subcategory": "cards", "subcategoryLabel": "Cards", "notes": [], - "bodyParameters": [], "descriptionHTML": "

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

Be 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\" endpoint.

", + "bodyParameters": [ + { + "description": "

Required. The project card's note

", + "example": "Update all gems", + "type": "string or nullable", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + { + "description": "

Required. The unique identifier of the content associated with the card

", + "example": 42, + "type": "integer", + "name": "content_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The unique identifier of the content associated with the card", + "childParamsGroups": [] + }, + { + "description": "

Required. The piece of content associated with the card

", + "example": "PullRequest", + "type": "string", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The piece of content associated with the card", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "201", @@ -23808,7 +23889,7 @@ "body": { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -23889,7 +23970,7 @@ { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -29285,7 +29366,7 @@ "type": "object", "properties": { "required_status_checks": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require status checks to pass before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -29351,7 +29432,7 @@ ] }, "enforce_admins": { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "nullable": true, "name": "enforce_admins", @@ -29361,7 +29442,7 @@ "childParamsGroups": [] }, "required_pull_request_reviews": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -29600,7 +29681,7 @@ ] }, "restrictions": { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "nullable": true, "properties": { @@ -29705,7 +29786,7 @@ "childParamsGroups": [] }, "allow_force_pushes": { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "nullable": true, "name": "allow_force_pushes", @@ -29820,7 +29901,7 @@ "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Protecting a branch requires admin or owner permissions to the repository.

\n

Note: Passing new arrays of users and teams replaces their previous values.

\n

Note: The list of users, apps, and teams in total is limited to 100 items.

", "bodyParameters": [ { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require status checks to pass before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -29886,7 +29967,7 @@ ] }, { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", "nullable": true, "name": "enforce_admins", @@ -29896,7 +29977,7 @@ "childParamsGroups": [] }, { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

", "nullable": true, "properties": { @@ -30135,7 +30216,7 @@ ] }, { - "type": "object or null", + "type": "object or nullable", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "nullable": true, "properties": { @@ -30240,7 +30321,7 @@ "childParamsGroups": [] }, { - "type": "boolean or null", + "type": "boolean or nullable", "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

", "nullable": true, "name": "allow_force_pushes", @@ -31818,11 +31899,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -31860,8 +31946,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -31952,11 +32051,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -31994,8 +32098,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -32081,11 +32198,16 @@ "type": "object", "properties": { "contexts": { - "type": "array", - "description": "contexts parameter", + "type": "array of strings", + "description": "

Required. contexts parameter

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] } }, "required": [ @@ -32123,8 +32245,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. contexts parameter

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "contexts parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -32462,11 +32597,16 @@ "type": "object", "properties": { "apps": { - "type": "array", - "description": "apps parameter", + "type": "array of strings", + "description": "

Required. apps parameter

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } }, "required": [ @@ -32503,8 +32643,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -32585,11 +32738,16 @@ "type": "object", "properties": { "apps": { - "type": "array", - "description": "apps parameter", + "type": "array of strings", + "description": "

Required. apps parameter

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } }, "required": [ @@ -32626,8 +32784,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -32708,11 +32879,16 @@ "type": "object", "properties": { "apps": { - "type": "array", - "description": "apps parameter", + "type": "array of strings", + "description": "

Required. apps parameter

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] } }, "required": [ @@ -32749,8 +32925,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. apps parameter

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "apps parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -32917,11 +33106,16 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -32959,8 +33153,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified teams push access for this branch. You can also give push access to child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -33041,11 +33248,16 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -33083,8 +33295,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayThe 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -33165,11 +33390,16 @@ "type": "object", "properties": { "teams": { - "type": "array", - "description": "teams parameter", + "type": "array of strings", + "description": "

Required. teams parameter

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] } }, "required": [ @@ -33207,8 +33437,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a team to push to this branch. You can also remove push access for child teams.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayTeams 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. teams parameter

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "teams parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -33375,11 +33618,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -33416,8 +33664,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified people push access for this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -33498,11 +33759,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -33539,8 +33805,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces 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\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -33621,11 +33900,16 @@ "type": "object", "properties": { "users": { - "type": "array", - "description": "users parameter", + "type": "array of strings", + "description": "

Required. users parameter

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] } }, "required": [ @@ -33662,8 +33946,21 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "bodyParameters": [], "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Removes the ability of a user to push to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames 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.
", + "bodyParameters": [ + { + "type": "array of strings", + "description": "

Required. users parameter

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "users parameter", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -38921,7 +39218,7 @@ "childParamsGroups": [] }, "dismissed_reason": { - "type": "string or null", + "type": "string or nullable", "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "nullable": true, "oneOf": [ @@ -38967,6 +39264,29 @@ "categoryLabel": "Code scanning", "notes": [], "descriptionHTML": "

Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if the repository is archived or if github advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "description": "

Required. Sets the state of the code scanning alert. Can be one of open or dismissed. You must provide dismissed_reason when you set the state to dismissed.

", @@ -38982,7 +39302,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", "nullable": true, "oneOf": [ @@ -39005,29 +39325,6 @@ "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -40002,7 +40299,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -40049,7 +40346,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -42643,7 +42940,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -42685,7 +42982,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -42720,7 +43017,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -42762,7 +43059,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -42911,7 +43208,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -42953,7 +43250,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -42988,7 +43285,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -43030,7 +43327,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -43800,7 +44097,8 @@ ], "name": "payload", "in": "body", - "description": "

undefined

", + "description": "

JSON payload with extra information about the deployment.

", + "type": "object or string", "childParamsGroups": [] }, "environment": { @@ -43814,7 +44112,7 @@ "childParamsGroups": [] }, "description": { - "type": "string or null", + "type": "string or nullable", "description": "

Short description of the deployment.

", "default": "", "nullable": true, @@ -43849,7 +44147,7 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -43904,6 +44202,30 @@ "subcategoryLabel": "Deployments", "notes": [], "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub AE we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Users with repo or repo_deployment scopes can create a deployment for a given ref.

\n

Merged branch response

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Simple example", + "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
" + }, + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Merged branch response", + "payload": "
{\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
" + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Conflict when there is a merge conflict or the commit's status checks failed" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ], "bodyParameters": [ { "type": "string", @@ -43960,7 +44282,8 @@ ], "name": "payload", "in": "body", - "description": "

undefined

", + "description": "

JSON payload with extra information about the deployment.

", + "type": "object or string", "childParamsGroups": [] }, { @@ -43974,7 +44297,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Short description of the deployment.

", "default": "", "nullable": true, @@ -44009,33 +44332,9 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Simple example", - "payload": "
{\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
" - }, - { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "Merged branch response", - "payload": "
{\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
" - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Conflict when there is a merge conflict or the commit's status checks failed" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } ] }, { @@ -46129,7 +46428,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -46184,7 +46483,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -46952,7 +47251,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -47022,7 +47321,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -47156,7 +47455,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -47226,7 +47525,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

\n

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

", "nullable": true, "name": "sha", @@ -47570,7 +47869,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "token": { @@ -47579,7 +47879,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "digest": { @@ -47588,7 +47888,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -47646,7 +47946,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -47655,7 +47956,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -47664,7 +47965,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -47810,7 +48111,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "token": { @@ -47819,7 +48121,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "digest": { @@ -47828,7 +48130,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -47886,7 +48188,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -47895,7 +48198,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -47904,7 +48207,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -48131,7 +48434,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "address": { @@ -48140,7 +48444,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "room": { @@ -48149,7 +48453,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -48210,7 +48514,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -48219,7 +48524,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -48228,7 +48533,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -48376,7 +48681,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, "address": { @@ -48385,7 +48691,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "room": { @@ -48394,7 +48700,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -48455,7 +48761,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] }, { @@ -48464,7 +48771,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -48473,7 +48780,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -48799,7 +49106,8 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } }, @@ -48827,6 +49135,14 @@ "subcategoryLabel": "Webhooks", "notes": [], "descriptionHTML": "

Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"

\n

Access tokens must have the write:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:write permission.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" + } + ], "bodyParameters": [ { "type": "string", @@ -48872,17 +49188,10 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

undefined

", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "type": "string or number", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" - } ] }, { @@ -49704,6 +50013,7 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "string or integer", "childParamsGroups": [] }, "body": { @@ -49716,7 +50026,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or null", + "type": "string or nullable", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "nullable": true, "name": "assignee", @@ -49738,12 +50048,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, "labels": { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -49821,6 +50131,39 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "oneOf": [ @@ -49835,6 +50178,7 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", + "type": "string or integer", "childParamsGroups": [] }, { @@ -49847,7 +50191,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

", "nullable": true, "name": "assignee", @@ -49869,12 +50213,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -49920,39 +50264,6 @@ "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -51162,11 +51473,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "undefined or null", + "type": "string or integer or nullable", "childParamsGroups": [] }, "body": { - "type": "string or null", + "type": "string or nullable", "description": "

The contents of the issue.

", "nullable": true, "name": "body", @@ -51176,7 +51487,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or null", + "type": "string or nullable", "nullable": true, "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", @@ -51211,12 +51522,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, "labels": { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -51291,6 +51602,44 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

Issue owners and users with push access can edit an issue.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], "bodyParameters": [ { "oneOf": [ @@ -51306,11 +51655,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "undefined or null", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "description": "

The contents of the issue.

", "nullable": true, "name": "body", @@ -51320,7 +51669,7 @@ "childParamsGroups": [] }, { - "type": "string or null", + "type": "string or nullable", "nullable": true, "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

", "name": "assignee", @@ -51355,12 +51704,12 @@ "nullable": true, "name": "milestone", "in": "body", - "type": "undefined or null", - "description": "

undefined

", + "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

", + "type": "string or integer or nullable", "childParamsGroups": [] }, { - "type": "array of undefineds", + "type": "array of strings or array of objects", "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

", "items": { "oneOf": [ @@ -51406,44 +51755,6 @@ "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } ] }, { @@ -52236,12 +52547,17 @@ "type": "object", "properties": { "labels": { - "type": "array", + "type": "array of strings", "minItems": 1, - "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "description": "

The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

", "items": { "type": "string" - } + }, + "name": "labels", + "in": "body", + "rawType": "array", + "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "childParamsGroups": [] } } }, @@ -52314,8 +52630,22 @@ "subcategory": "labels", "subcategoryLabel": "Labels", "notes": [], - "bodyParameters": [], "descriptionHTML": "", + "bodyParameters": [ + { + "type": "array of strings", + "minItems": 1, + "description": "

The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

", + "items": { + "type": "string" + }, + "name": "labels", + "in": "body", + "rawType": "array", + "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", @@ -56085,7 +56415,7 @@ "type": "object", "properties": { "cname": { - "type": "string or null", + "type": "string or nullable", "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

", "nullable": true, "name": "cname", @@ -56148,7 +56478,8 @@ ], "name": "source", "in": "body", - "description": "

undefined

", + "type": "", + "description": "", "childParamsGroups": [] } }, @@ -56218,7 +56549,7 @@ "descriptionHTML": "

Updates information for a GitHub AE Pages site. For more information, see \"About GitHub Pages.

", "bodyParameters": [ { - "type": "string or null", + "type": "string or nullable", "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

", "nullable": true, "name": "cname", @@ -56281,7 +56612,8 @@ ], "name": "source", "in": "body", - "description": "

undefined

", + "type": "", + "description": "", "childParamsGroups": [] } ] @@ -57254,7 +57586,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -57346,7 +57678,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -58794,7 +59126,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -58939,7 +59271,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -60236,7 +60568,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "side": { @@ -60245,7 +60577,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_line": { @@ -60254,7 +60586,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_side": { @@ -60263,7 +60595,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -60315,7 +60647,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -60324,7 +60656,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -60333,7 +60665,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -60342,7 +60674,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -60471,7 +60803,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "side": { @@ -60480,7 +60812,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_line": { @@ -60489,7 +60821,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "start_side": { @@ -60498,7 +60830,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -60550,7 +60882,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -60559,7 +60891,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -60568,7 +60900,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -60577,7 +60909,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ] @@ -61109,7 +61441,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } }, @@ -61150,7 +61482,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -62149,7 +62481,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } } @@ -62200,7 +62532,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] } ], @@ -65376,7 +65708,7 @@ "name": "members", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [ { "parentName": "members", @@ -65485,7 +65817,7 @@ "name": "members", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [ { "parentName": "members", @@ -65686,7 +66018,7 @@ "name": "members", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [ { "parentName": "members", @@ -65795,7 +66127,7 @@ "name": "members", "in": "body", "rawType": "array", - "description": "

undefined

", + "description": "", "childParamsGroups": [ { "parentName": "members", @@ -65903,7 +66235,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "path": { @@ -65911,7 +66243,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "value": { @@ -65928,7 +66260,8 @@ ], "name": "value", "in": "body", - "description": "

undefined

", + "type": "string or object or array", + "description": "", "childParamsGroups": [] } }, @@ -65959,7 +66292,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -65967,7 +66300,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -65984,7 +66317,8 @@ ], "name": "value", "in": "body", - "description": "

undefined

", + "type": "string or object or array", + "description": "", "childParamsGroups": [] } ] @@ -66071,7 +66405,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, "path": { @@ -66079,7 +66413,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, "value": { @@ -66096,7 +66430,8 @@ ], "name": "value", "in": "body", - "description": "

undefined

", + "type": "string or object or array", + "description": "", "childParamsGroups": [] } }, @@ -66127,7 +66462,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

Required. undefined

", + "description": "

Required.

", "childParamsGroups": [] }, { @@ -66135,7 +66470,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "

undefined

", + "description": "", "childParamsGroups": [] }, { @@ -66152,7 +66487,8 @@ ], "name": "value", "in": "body", - "description": "

undefined

", + "type": "string or object or array", + "description": "", "childParamsGroups": [] } ] @@ -67235,7 +67571,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -67320,7 +67656,7 @@ "childParamsGroups": [] }, { - "type": "integer or null", + "type": "integer or nullable", "description": "

The ID of a team to set as the parent team.

", "nullable": true, "name": "parent_team_id", @@ -70673,7 +71009,7 @@ }, "twitter_username": { "description": "

The new Twitter username of the user.

", - "type": "string or null", + "type": "string or nullable", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -70770,7 +71106,7 @@ }, { "description": "

The new Twitter username of the user.

", - "type": "string or null", + "type": "string or nullable", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -72985,7 +73321,7 @@ "body": { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", @@ -73035,7 +73371,7 @@ { "description": "

Body of the project

", "example": "This project represents the sprint of the first week in January", - "type": "string or null", + "type": "string or nullable", "nullable": true, "name": "body", "in": "body", diff --git a/script/rest/utils/operation.js b/script/rest/utils/operation.js index c81f946aadd0..f2a6d6be07cc 100644 --- a/script/rest/utils/operation.js +++ b/script/rest/utils/operation.js @@ -166,8 +166,43 @@ module.exports = class Operation { } async renderBodyParameterDescriptions () { - const bodyParamsObject = get(this, 'requestBody.content.application/json.schema.properties', {}) - const requiredParams = get(this, 'requestBody.content.application/json.schema.required', []) + let bodyParamsObject = get(this, 'requestBody.content.application/json.schema.properties', {}) + let requiredParams = get(this, 'requestBody.content.application/json.schema.required', []) + const oneOfObject = get(this, 'requestBody.content.application/json.schema.oneOf', undefined) + + // oneOf is an array of input parameter options, so we need to either + // use the first option or munge the options together. + if (oneOfObject) { + const firstOneOfObject = oneOfObject[0] + const allOneOfAreObjects = oneOfObject + .filter(elem => elem.type === 'object') + .length === oneOfObject.length + + // TODO: Remove this check + // This operation shouldn't have a oneOf in this case, it needs to be + // removed from the schema in the github/github repo. + if (this.operationId === 'checks/create') { + delete bodyParamsObject.oneOf + } else if (allOneOfAreObjects) { + // When all of the oneOf objects have the `type: object` we + // need to display all of the parameters. + // This merges all of the properties and required values into the + // first requestBody object. + for (let i = 1; i < oneOfObject.length; i++) { + Object.assign(firstOneOfObject.properties, oneOfObject[i].properties) + requiredParams = firstOneOfObject.required + .concat(oneOfObject[i].required) + } + bodyParamsObject = firstOneOfObject.properties + } else if (oneOfObject) { + // When a oneOf exists but the `type` differs, the case has historically + // been that the alternate option is an array, where the first option + // is the array as a property of the object. We need to ensure that the + // first option listed is the most comprehensive and preferred option. + bodyParamsObject = firstOneOfObject.properties + requiredParams = firstOneOfObject.required + } + } this.bodyParameters = await getBodyParams(bodyParamsObject, requiredParams) } @@ -211,16 +246,57 @@ async function getBodyParams (paramsObject, requiredParams) { param.rawType = param.type param.rawDescription = param.description - // e.g. array of strings - param.type = param.type === 'array' - ? `array of ${param.items.type}s` - : param.type + // Stores the types listed under the `Type` column in the `Parameters` + // table in the REST API docs. When the parameter contains oneOf + // there are multiple acceptable parameters that we should list. + const paramArray = [] + + const oneOfArray = param.oneOf + const isOneOfObjectOrArray = oneOfArray + ? oneOfArray.filter(elem => elem.type !== 'object' || elem.type !== 'array') + : false + + // When oneOf has the type array or object, the type is defined + // in a child object + if (oneOfArray && isOneOfObjectOrArray.length > 0) { + // Store the defined types + paramArray.push(oneOfArray + .filter(elem => elem.type) + .map(elem => elem.type) + ) + + // If an object doesn't have a description, it is invalid + const oneOfArrayWithDescription = oneOfArray.filter(elem => elem.description) + + // Use the parent description when set, otherwise enumerate each + // description in the `Description` column of the `Parameters` table. + if (!param.description && oneOfArrayWithDescription.length > 1) { + param.description = oneOfArray + .filter(elem => elem.description) + .map(elem => `**Type ${elem.type}** - ${elem.description}`) + .join('\n\n') + } else if (!param.description && oneOfArrayWithDescription.length === 1) { + // When there is only on valid description, use that one. + param.description = oneOfArrayWithDescription[0].description + } + } + + // Arrays require modifying the displayed type (e.g., array of strings) + if (param.type === 'array') { + if (param.items.type) paramArray.push(`array of ${param.items.type}s`) + if (param.items.oneOf) { + paramArray.push(param.items.oneOf + .map(elem => `array of ${elem.type}s`) + ) + } + } else if (param.type) { + paramArray.push(param.type) + } - // e.g. object or null - param.type = param.nullable - ? `${param.type} or null` - : param.type + if (param.nullable) paramArray.push('nullable') + param.type = paramArray.flat().join(' or ') + param.description = param.description || '' const isRequired = requiredParams && requiredParams.includes(param.name) const requiredString = isRequired ? '**Required**. ' : '' param.description = await renderContent(requiredString + param.description) @@ -245,8 +321,9 @@ async function getBodyParams (paramsObject, requiredParams) { } async function getChildParamsGroup (param) { - // only objects and arrays of objects ever have child params - if (!(param.rawType === 'array' || param.rawType === 'object')) return + // only objects, arrays of objects, anyOf, allOf, and oneOf have child params + if (!(param.rawType === 'array' || param.rawType === 'object' || param.oneOf)) return + if (param.oneOf && !param.oneOf.filter(param => param.type === 'object' || param.type === 'array')) return if (param.items && param.items.type !== 'object') return const childParamsObject = param.rawType === 'array' ? param.items.properties : param.properties