Update OpenAPI Descriptions (#23243)
This commit is contained in:
github-openapi-bot
committed by
GitHub
GitHub
parent
3c6f09db23
commit
0cc679bd1e
@@ -39828,14 +39828,15 @@
|
||||
},
|
||||
"contexts": {
|
||||
"type": "array of strings",
|
||||
"description": "<p><strong>Required</strong>. 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 <code>checks</code> instead of <code>contexts</code> for more fine-grained control.</p>",
|
||||
"deprecated": true,
|
||||
"description": "<p><strong>Required</strong>. <strong>Deprecated</strong>: 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 <code>checks</code> instead of <code>contexts</code> for more fine-grained control.</p>",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": "contexts",
|
||||
"in": "body",
|
||||
"rawType": "array",
|
||||
"rawDescription": "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.",
|
||||
"rawDescription": "**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",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"checks": {
|
||||
@@ -39843,10 +39844,13 @@
|
||||
"description": "<p>The list of status checks to require in order to merge into this branch.</p>",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"context"
|
||||
],
|
||||
"properties": {
|
||||
"context": {
|
||||
"type": "string",
|
||||
"description": "<p>The name of the required check</p>",
|
||||
"description": "<p><strong>Required</strong>. The name of the required check</p>",
|
||||
"name": "context",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
@@ -39855,11 +39859,11 @@
|
||||
},
|
||||
"app_id": {
|
||||
"type": "integer",
|
||||
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
|
||||
"description": "<p>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.</p>",
|
||||
"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": "<p>The name of the required check</p>",
|
||||
"description": "<p><strong>Required</strong>. The name of the required check</p>",
|
||||
"name": "context",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
@@ -39885,11 +39889,11 @@
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
|
||||
"description": "<p>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.</p>",
|
||||
"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": "<p><strong>Required</strong>. 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 <code>checks</code> instead of <code>contexts</code> for more fine-grained control.</p>",
|
||||
"deprecated": true,
|
||||
"description": "<p><strong>Required</strong>. <strong>Deprecated</strong>: 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 <code>checks</code> instead of <code>contexts</code> for more fine-grained control.</p>",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": "contexts",
|
||||
"in": "body",
|
||||
"rawType": "array",
|
||||
"rawDescription": "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.",
|
||||
"rawDescription": "**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",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
@@ -39937,10 +39942,13 @@
|
||||
"description": "<p>The list of status checks to require in order to merge into this branch.</p>",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"context"
|
||||
],
|
||||
"properties": {
|
||||
"context": {
|
||||
"type": "string",
|
||||
"description": "<p>The name of the required check</p>",
|
||||
"description": "<p><strong>Required</strong>. The name of the required check</p>",
|
||||
"name": "context",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
@@ -39949,11 +39957,11 @@
|
||||
},
|
||||
"app_id": {
|
||||
"type": "integer",
|
||||
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
|
||||
"description": "<p>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.</p>",
|
||||
"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": "<p>The name of the required check</p>",
|
||||
"description": "<p><strong>Required</strong>. The name of the required check</p>",
|
||||
"name": "context",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
@@ -39979,11 +39987,11 @@
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
|
||||
"description": "<p>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.</p>",
|
||||
"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": "<p>The name of the required check</p>",
|
||||
"description": "<p><strong>Required</strong>. The name of the required check</p>",
|
||||
"name": "context",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
@@ -40008,11 +40016,11 @@
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
|
||||
"description": "<p>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.</p>",
|
||||
"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": "<p><strong>Required</strong>. 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 <code>checks</code> instead of <code>contexts</code> for more fine-grained control.</p>",
|
||||
"deprecated": true,
|
||||
"description": "<p><strong>Required</strong>. <strong>Deprecated</strong>: 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 <code>checks</code> instead of <code>contexts</code> for more fine-grained control.</p>",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": "contexts",
|
||||
"in": "body",
|
||||
"rawType": "array",
|
||||
"rawDescription": "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.",
|
||||
"rawDescription": "**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",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"checks": {
|
||||
@@ -40517,10 +40526,13 @@
|
||||
"description": "<p>The list of status checks to require in order to merge into this branch.</p>",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"context"
|
||||
],
|
||||
"properties": {
|
||||
"context": {
|
||||
"type": "string",
|
||||
"description": "<p>The name of the required check</p>",
|
||||
"description": "<p><strong>Required</strong>. The name of the required check</p>",
|
||||
"name": "context",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
@@ -40529,11 +40541,11 @@
|
||||
},
|
||||
"app_id": {
|
||||
"type": "integer",
|
||||
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
|
||||
"description": "<p>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.</p>",
|
||||
"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": "<p>The name of the required check</p>",
|
||||
"description": "<p><strong>Required</strong>. The name of the required check</p>",
|
||||
"name": "context",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
@@ -40559,11 +40571,11 @@
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
|
||||
"description": "<p>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.</p>",
|
||||
"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": "<p><strong>Required</strong>. 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 <code>checks</code> instead of <code>contexts</code> for more fine-grained control.</p>",
|
||||
"deprecated": true,
|
||||
"description": "<p><strong>Required</strong>. <strong>Deprecated</strong>: 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 <code>checks</code> instead of <code>contexts</code> for more fine-grained control.</p>",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": "contexts",
|
||||
"in": "body",
|
||||
"rawType": "array",
|
||||
"rawDescription": "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.",
|
||||
"rawDescription": "**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",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
@@ -40611,10 +40624,13 @@
|
||||
"description": "<p>The list of status checks to require in order to merge into this branch.</p>",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"context"
|
||||
],
|
||||
"properties": {
|
||||
"context": {
|
||||
"type": "string",
|
||||
"description": "<p>The name of the required check</p>",
|
||||
"description": "<p><strong>Required</strong>. The name of the required check</p>",
|
||||
"name": "context",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
@@ -40623,11 +40639,11 @@
|
||||
},
|
||||
"app_id": {
|
||||
"type": "integer",
|
||||
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
|
||||
"description": "<p>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.</p>",
|
||||
"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": "<p>The name of the required check</p>",
|
||||
"description": "<p><strong>Required</strong>. The name of the required check</p>",
|
||||
"name": "context",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
@@ -40653,11 +40669,11 @@
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
|
||||
"description": "<p>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.</p>",
|
||||
"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": "<p>The name of the required check</p>",
|
||||
"description": "<p><strong>Required</strong>. The name of the required check</p>",
|
||||
"name": "context",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
@@ -40682,11 +40698,11 @@
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
|
||||
"description": "<p>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.</p>",
|
||||
"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": "<p>The list of status checks to require in order to merge into this branch</p>",
|
||||
"deprecated": true,
|
||||
"description": "<p><strong>Deprecated</strong>: 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 <code>checks</code> instead of <code>contexts</code> for more fine-grained control.</p>",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": "contexts",
|
||||
"in": "body",
|
||||
"rawType": "array",
|
||||
"rawDescription": "The list of status checks to require in order to merge into this branch",
|
||||
"rawDescription": "**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",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"checks": {
|
||||
"type": "array of objects",
|
||||
"description": "<p>The list of status checks to require in order to merge into this branch.</p>",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"context"
|
||||
],
|
||||
"properties": {
|
||||
"context": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The name of the required check</p>",
|
||||
"name": "context",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The name of the required check",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"app_id": {
|
||||
"type": "integer",
|
||||
"description": "<p>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.</p>",
|
||||
"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": "<p><strong>Required</strong>. The name of the required check</p>",
|
||||
"name": "context",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The name of the required check",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p>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.</p>",
|
||||
"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": "<p>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 <a href=\"https://help.github.com/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>Require branches to be up to date before merging.</p>",
|
||||
"name": "strict",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Require branches to be up to date before merging.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "array of strings",
|
||||
"description": "<p>The list of status checks to require in order to merge into this branch</p>",
|
||||
"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": "<p>Require branches to be up to date before merging.</p>",
|
||||
"name": "strict",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Require branches to be up to date before merging.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "array of strings",
|
||||
"deprecated": true,
|
||||
"description": "<p><strong>Deprecated</strong>: 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 <code>checks</code> instead of <code>contexts</code> for more fine-grained control.</p>",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": "contexts",
|
||||
"in": "body",
|
||||
"rawType": "array",
|
||||
"rawDescription": "**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",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "array of objects",
|
||||
"description": "<p>The list of status checks to require in order to merge into this branch.</p>",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"context"
|
||||
],
|
||||
"properties": {
|
||||
"context": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The name of the required check</p>",
|
||||
"name": "context",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The name of the required check",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"app_id": {
|
||||
"type": "integer",
|
||||
"description": "<p>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.</p>",
|
||||
"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": "<p><strong>Required</strong>. The name of the required check</p>",
|
||||
"name": "context",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The name of the required check",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "<p>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.</p>",
|
||||
"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": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user