Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -39855,11 +39859,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -39876,7 +39880,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -39885,11 +39889,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -39922,14 +39926,15 @@ }, { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -39949,11 +39957,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -39970,7 +39978,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -39979,11 +39987,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -39999,7 +40007,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -40008,11 +40016,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -40502,14 +40510,15 @@ }, "contexts": { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -40529,11 +40541,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -40550,7 +40562,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -40559,11 +40571,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -40596,14 +40608,15 @@ }, { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -40623,11 +40639,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -40644,7 +40660,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -40653,11 +40669,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -40673,7 +40689,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -40682,11 +40698,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -42263,7 +42279,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/rest/reference/repos#update-status-check-protection" }, "requestBody": { "required": false, @@ -42283,15 +42299,77 @@ }, "contexts": { "type": "array of strings", - "description": "The list of status checks to require in order to merge into this branch
", + "deprecated": true, + "description": "Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", + "items": { + "type": "object", + "required": [ + "context" + ], + "properties": { + "context": { + "type": "string", + "description": "Required. The name of the required check
", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "integer", + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "Required. The name of the required check
", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", + "childParamsGroups": [] + } + ] + } + ] } } }, @@ -42318,29 +42396,6 @@ "contentType": "application/json", "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.
\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
", - "bodyParameters": [ - { - "type": "boolean", - "description": "Require branches to be up to date before merging.
", - "name": "strict", - "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "childParamsGroups": [] - }, - { - "type": "array of strings", - "description": "The list of status checks to require in order to merge into this branch
", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -42358,6 +42413,91 @@ "httpStatusMessage": "Unprocessable Entity", "description": "Validation failed" } + ], + "bodyParameters": [ + { + "type": "boolean", + "description": "Require branches to be up to date before merging.
", + "name": "strict", + "in": "body", + "rawType": "boolean", + "rawDescription": "Require branches to be up to date before merging.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "deprecated": true, + "description": "Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", + "items": { + "type": "object", + "required": [ + "context" + ], + "properties": { + "context": { + "type": "string", + "description": "Required. The name of the required check
", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "integer", + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "Required. The name of the required check
", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", + "childParamsGroups": [] + } + ] + } + ] + } ] }, { diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json index 402a9da62d..d0310be13c 100644 --- a/lib/rest/static/decorated/ghes-3.0.json +++ b/lib/rest/static/decorated/ghes-3.0.json @@ -36177,14 +36177,15 @@ }, "contexts": { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -36204,11 +36208,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -36225,7 +36229,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -36234,11 +36238,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -36271,14 +36275,15 @@ }, { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -36298,11 +36306,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -36319,7 +36327,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -36328,11 +36336,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -36348,7 +36356,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -36357,11 +36365,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -36749,6 +36757,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + "contexts": { + "type": "array of strings", + "description": "The list of status checks to require in order to merge into this branch.
", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.\n", + "childParamsGroups": [] } }, "required": [ @@ -36859,14 +36879,15 @@ }, "contexts": { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -36886,11 +36910,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -36907,7 +36931,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -36916,11 +36940,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -36953,14 +36977,15 @@ }, { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -36980,11 +37008,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -37001,7 +37029,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -37010,11 +37038,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37030,7 +37058,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -37039,11 +37067,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37431,6 +37459,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "The list of status checks to require in order to merge into this branch.
", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.\n", + "childParamsGroups": [] } ] }, @@ -38660,7 +38700,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-status-check-protection" }, "requestBody": { "required": false, @@ -38680,6 +38720,7 @@ }, "contexts": { "type": "array of strings", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch
", "items": { "type": "string" @@ -38727,6 +38768,7 @@ }, { "type": "array of strings", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch
", "items": { "type": "string" diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index 9ea6f35bfa..c38acd05af 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -36299,14 +36299,15 @@ }, "contexts": { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -36326,11 +36330,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -36347,7 +36351,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -36356,11 +36360,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -36393,14 +36397,15 @@ }, { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -36420,11 +36428,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -36441,7 +36449,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -36450,11 +36458,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -36470,7 +36478,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -36479,11 +36487,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -36871,6 +36879,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + "contexts": { + "type": "array of strings", + "description": "The list of status checks to require in order to merge into this branch.
", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.\n", + "childParamsGroups": [] } }, "required": [ @@ -36981,14 +37001,15 @@ }, "contexts": { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -37008,11 +37032,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -37029,7 +37053,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -37038,11 +37062,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37075,14 +37099,15 @@ }, { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -37102,11 +37130,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -37123,7 +37151,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -37132,11 +37160,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37152,7 +37180,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -37161,11 +37189,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37553,6 +37581,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "The list of status checks to require in order to merge into this branch.
", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.\n", + "childParamsGroups": [] } ] }, @@ -38782,7 +38822,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#update-status-check-protection" }, "requestBody": { "required": false, @@ -38802,6 +38842,7 @@ }, "contexts": { "type": "array of strings", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch
", "items": { "type": "string" @@ -38849,6 +38890,7 @@ }, { "type": "array of strings", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch
", "items": { "type": "string" diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index 83f1f5d6c9..dd1bffaee2 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -37545,14 +37545,15 @@ }, "contexts": { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -37572,11 +37576,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -37593,7 +37597,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -37602,11 +37606,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37639,14 +37643,15 @@ }, { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -37666,11 +37674,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -37687,7 +37695,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -37696,11 +37704,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37716,7 +37724,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -37725,11 +37733,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -38117,6 +38125,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + "contexts": { + "type": "array of strings", + "description": "The list of status checks to require in order to merge into this branch.
", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.\n", + "childParamsGroups": [] } }, "required": [ @@ -38227,14 +38247,15 @@ }, "contexts": { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -38254,11 +38278,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -38275,7 +38299,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -38284,11 +38308,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -38321,14 +38345,15 @@ }, { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -38348,11 +38376,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -38369,7 +38397,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -38378,11 +38406,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -38398,7 +38426,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -38407,11 +38435,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -38799,6 +38827,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "The list of status checks to require in order to merge into this branch.
", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.\n", + "childParamsGroups": [] } ] }, @@ -40028,7 +40068,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#update-status-check-protection" }, "requestBody": { "required": false, @@ -40048,6 +40088,7 @@ }, "contexts": { "type": "array of strings", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch
", "items": { "type": "string" @@ -40095,6 +40136,7 @@ }, { "type": "array of strings", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch
", "items": { "type": "string" diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index 0766964864..8874a9736d 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -37781,14 +37781,15 @@ }, "contexts": { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -37808,11 +37812,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -37829,7 +37833,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -37838,11 +37842,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37875,14 +37879,15 @@ }, { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -37902,11 +37910,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -37923,7 +37931,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -37932,11 +37940,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -37952,7 +37960,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -37961,11 +37969,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -38353,6 +38361,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + "contexts": { + "type": "array of strings", + "description": "The list of status checks to require in order to merge into this branch.
", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.\n", + "childParamsGroups": [] } }, "required": [ @@ -38455,14 +38475,15 @@ }, "contexts": { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -38482,11 +38506,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -38503,7 +38527,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -38512,11 +38536,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -38549,14 +38573,15 @@ }, { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -38576,11 +38604,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -38597,7 +38625,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -38606,11 +38634,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -38626,7 +38654,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -38635,11 +38663,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -39027,6 +39055,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "The list of status checks to require in order to merge into this branch.
", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.\n", + "childParamsGroups": [] } ] }, @@ -40216,7 +40256,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#update-status-check-protection" }, "requestBody": { "required": false, @@ -40236,6 +40276,7 @@ }, "contexts": { "type": "array of strings", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch
", "items": { "type": "string" @@ -40283,6 +40324,7 @@ }, { "type": "array of strings", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch
", "items": { "type": "string" diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 69b3b34828..e2c05fd187 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -29886,14 +29886,15 @@ }, "contexts": { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -29913,11 +29917,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -29934,7 +29938,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -29943,11 +29947,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -29980,14 +29984,15 @@ }, { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -30007,11 +30015,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -30028,7 +30036,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -30037,11 +30045,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -30057,7 +30065,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -30066,11 +30074,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -30458,6 +30466,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + "contexts": { + "type": "array of strings", + "description": "The list of status checks to require in order to merge into this branch.
", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.\n", + "childParamsGroups": [] } }, "required": [ @@ -30560,14 +30580,15 @@ }, "contexts": { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -30587,11 +30611,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -30608,7 +30632,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -30617,11 +30641,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -30654,14 +30678,15 @@ }, { "type": "array of strings", - "description": "Required. The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.
The list of status checks to require in order to merge into this branch.
", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -30681,11 +30709,11 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } } @@ -30702,7 +30730,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -30711,11 +30739,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -30731,7 +30759,7 @@ "params": [ { "type": "string", - "description": "The name of the required check
", + "description": "Required. The name of the required check
", "name": "context", "in": "body", "rawType": "string", @@ -30740,11 +30768,11 @@ }, { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to null to accept the check from any source.
The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.
", "name": "app_id", "in": "body", "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App.", "childParamsGroups": [] } ] @@ -31132,6 +31160,18 @@ "rawType": "boolean", "rawDescription": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "The list of status checks to require in order to merge into this branch.
", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.\n", + "childParamsGroups": [] } ] }, @@ -32321,7 +32361,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#update-status-check-protection" }, "requestBody": { "required": false, @@ -32341,6 +32381,7 @@ }, "contexts": { "type": "array of strings", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch
", "items": { "type": "string" @@ -32388,6 +32429,7 @@ }, { "type": "array of strings", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch
", "items": { "type": "string" diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 0ad9cf1ab5..18628edff8 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -153145,6 +153145,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -153186,7 +153188,8 @@ } }, "required": [ - "contexts" + "contexts", + "checks" ] }, "enforce_admins": { @@ -154564,6 +154567,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -154605,7 +154610,8 @@ } }, "required": [ - "contexts" + "contexts", + "checks" ] }, "enforce_admins": { @@ -155474,6 +155480,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -155515,7 +155523,8 @@ } }, "required": [ - "contexts" + "contexts", + "checks" ] }, "enforce_admins": { @@ -156474,7 +156483,8 @@ }, "contexts": { "type": "array", - "description": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "deprecated": true, + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "items": { "type": "string" } @@ -156484,6 +156494,9 @@ "description": "The list of status checks to require in order to merge into this branch.", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", @@ -156491,7 +156504,7 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App." } } } @@ -156693,7 +156706,11 @@ "type": "integer", "nullable": true } - } + }, + "required": [ + "context", + "app_id" + ] } }, "contexts_url": { @@ -156706,7 +156723,8 @@ "url", "contexts_url", "strict", - "contexts" + "contexts", + "checks" ] }, "required_pull_request_reviews": { @@ -159302,7 +159320,11 @@ "type": "integer", "nullable": true } - } + }, + "required": [ + "context", + "app_id" + ] } }, "contexts_url": { @@ -159315,7 +159337,8 @@ "url", "contexts_url", "strict", - "contexts" + "contexts", + "checks" ] }, "examples": { @@ -159376,7 +159399,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/rest/reference/repos#update-status-check-protection" }, "parameters": [ { @@ -159419,10 +159442,31 @@ }, "contexts": { "type": "array", - "description": "The list of status checks to require in order to merge into this branch", + "deprecated": true, + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "items": { "type": "string" } + }, + "checks": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.", + "items": { + "type": "object", + "required": [ + "context" + ], + "properties": { + "context": { + "type": "string", + "description": "The name of the required check" + }, + "app_id": { + "type": "integer", + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App." + } + } + } } } }, @@ -159476,7 +159520,11 @@ "type": "integer", "nullable": true } - } + }, + "required": [ + "context", + "app_id" + ] } }, "contexts_url": { @@ -159489,7 +159537,8 @@ "url", "contexts_url", "strict", - "contexts" + "contexts", + "checks" ] }, "examples": { @@ -165717,6 +165766,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -165758,7 +165809,8 @@ } }, "required": [ - "contexts" + "contexts", + "checks" ] }, "enforce_admins": { diff --git a/lib/rest/static/dereferenced/ghes-3.0.deref.json b/lib/rest/static/dereferenced/ghes-3.0.deref.json index 83b527c42c..01a1a0cd30 100644 --- a/lib/rest/static/dereferenced/ghes-3.0.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.0.deref.json @@ -128557,6 +128557,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -128571,25 +128573,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -129976,6 +129959,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -129990,25 +129975,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -130886,6 +130852,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -130900,25 +130868,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -131893,7 +131842,8 @@ }, "contexts": { "type": "array", - "description": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "deprecated": true, + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "items": { "type": "string" } @@ -131903,6 +131853,9 @@ "description": "The list of status checks to require in order to merge into this branch.", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", @@ -131910,7 +131863,7 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App." } } } @@ -132013,6 +131966,13 @@ "required_conversation_resolution": { "type": "boolean", "description": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`." + }, + "contexts": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.\n", + "items": { + "type": "string" + } } }, "required": [ @@ -132099,22 +132059,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -134750,22 +134694,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -134837,7 +134765,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-status-check-protection" }, "parameters": [ { @@ -134880,6 +134808,7 @@ }, "contexts": { "type": "array", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" @@ -134924,22 +134853,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index e4d7bcbca3..9569538fb7 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -128872,6 +128872,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -128886,25 +128888,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -130291,6 +130274,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -130305,25 +130290,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -131201,6 +131167,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -131215,25 +131183,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -132208,7 +132157,8 @@ }, "contexts": { "type": "array", - "description": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "deprecated": true, + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "items": { "type": "string" } @@ -132218,6 +132168,9 @@ "description": "The list of status checks to require in order to merge into this branch.", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", @@ -132225,7 +132178,7 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App." } } } @@ -132328,6 +132281,13 @@ "required_conversation_resolution": { "type": "boolean", "description": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`." + }, + "contexts": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.\n", + "items": { + "type": "string" + } } }, "required": [ @@ -132414,22 +132374,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -135065,22 +135009,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -135152,7 +135080,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#update-status-check-protection" }, "parameters": [ { @@ -135195,6 +135123,7 @@ }, "contexts": { "type": "array", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" @@ -135239,22 +135168,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -141493,6 +141406,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -141507,25 +141422,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index 8f2dabff4d..a13aece9c4 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -132489,6 +132489,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -132503,25 +132505,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -133908,6 +133891,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -133922,25 +133907,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -134818,6 +134784,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -134832,25 +134800,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -135825,7 +135774,8 @@ }, "contexts": { "type": "array", - "description": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "deprecated": true, + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "items": { "type": "string" } @@ -135835,6 +135785,9 @@ "description": "The list of status checks to require in order to merge into this branch.", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", @@ -135842,7 +135795,7 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App." } } } @@ -135945,6 +135898,13 @@ "required_conversation_resolution": { "type": "boolean", "description": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`." + }, + "contexts": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.\n", + "items": { + "type": "string" + } } }, "required": [ @@ -136031,22 +135991,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -138682,22 +138626,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -138769,7 +138697,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#update-status-check-protection" }, "parameters": [ { @@ -138812,6 +138740,7 @@ }, "contexts": { "type": "array", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" @@ -138856,22 +138785,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -145110,6 +145023,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -145124,25 +145039,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index 68a5b11f1c..10a6e8b3a0 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -139384,6 +139384,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -139398,25 +139400,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -140803,6 +140786,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -140817,25 +140802,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -141713,6 +141679,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -141727,25 +141695,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, @@ -142713,7 +142662,8 @@ }, "contexts": { "type": "array", - "description": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "deprecated": true, + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "items": { "type": "string" } @@ -142723,6 +142673,9 @@ "description": "The list of status checks to require in order to merge into this branch.", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", @@ -142730,7 +142683,7 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App." } } } @@ -142833,6 +142786,13 @@ "required_conversation_resolution": { "type": "boolean", "description": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`." + }, + "contexts": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.\n", + "items": { + "type": "string" + } } }, "required": [ @@ -142919,22 +142879,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -145528,22 +145472,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -145615,7 +145543,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#update-status-check-protection" }, "parameters": [ { @@ -145658,6 +145586,7 @@ }, "contexts": { "type": "array", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" @@ -145702,22 +145631,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -151956,6 +151869,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -151970,25 +151885,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string" - }, - "app_id": { - "type": "integer", - "nullable": true - } - }, - "required": [ - "context", - "app_id" - ] - } - }, "contexts_url": { "type": "string" }, diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index dbbf6f404e..4b367aba31 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -104170,6 +104170,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -104211,7 +104213,8 @@ } }, "required": [ - "contexts" + "contexts", + "checks" ] }, "enforce_admins": { @@ -105589,6 +105592,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -105630,7 +105635,8 @@ } }, "required": [ - "contexts" + "contexts", + "checks" ] }, "enforce_admins": { @@ -106499,6 +106505,8 @@ "type": "boolean" }, "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { "url": { @@ -106540,7 +106548,8 @@ } }, "required": [ - "contexts" + "contexts", + "checks" ] }, "enforce_admins": { @@ -107499,7 +107508,8 @@ }, "contexts": { "type": "array", - "description": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "deprecated": true, + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "items": { "type": "string" } @@ -107509,6 +107519,9 @@ "description": "The list of status checks to require in order to merge into this branch.", "items": { "type": "object", + "required": [ + "context" + ], "properties": { "context": { "type": "string", @@ -107516,7 +107529,7 @@ }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source." + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App." } } } @@ -107619,6 +107632,13 @@ "required_conversation_resolution": { "type": "boolean", "description": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`." + }, + "contexts": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.\n", + "items": { + "type": "string" + } } }, "required": [ @@ -107705,22 +107725,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -110314,22 +110318,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri", @@ -110401,7 +110389,7 @@ "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#update-status-check-potection" + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#update-status-check-protection" }, "parameters": [ { @@ -110444,6 +110432,7 @@ }, "contexts": { "type": "array", + "deprecated": true, "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" @@ -110488,22 +110477,6 @@ "type": "string" } }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "example": "continuous-integration/travis-ci" - }, - "app_id": { - "type": "integer", - "nullable": true - } - } - } - }, "contexts_url": { "type": "string", "format": "uri",