зеркало из https://github.com/github/docs.git
Update OpenAPI Descriptions (#17697)
* Update OpenAPI Descriptions * Add decorated OpenAPI schema files
This commit is contained in:
github-openapi-bot
GitHub
Родитель
a5058afb0d
Коммит
7e862d6ddb
|
|
@ -32438,18 +32438,28 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "status",
|
"name": "status",
|
||||||
"description": "Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in \"[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run).\"",
|
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run).\"",
|
||||||
"in": "query",
|
"in": "query",
|
||||||
"required": false,
|
"required": false,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"completed",
|
"completed",
|
||||||
"status",
|
"action_required",
|
||||||
"conclusion"
|
"cancelled",
|
||||||
|
"failure",
|
||||||
|
"neutral",
|
||||||
|
"skipped",
|
||||||
|
"stale",
|
||||||
|
"success",
|
||||||
|
"timed_out",
|
||||||
|
"in_progress",
|
||||||
|
"queued",
|
||||||
|
"requested",
|
||||||
|
"waiting"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"descriptionHTML": "<p>Returns workflow runs associated with the check run <code>status</code> or <code>conclusion</code> you specify. For example, a conclusion can be <code>success</code> or a status can be <code>completed</code>. For more information, see the <code>status</code> and <code>conclusion</code> options available in \"<a href=\"https://docs.github.com/rest/reference/checks#create-a-check-run\">Create a check run</a>.\"</p>"
|
"descriptionHTML": "<p>Returns workflow runs with the check run <code>status</code> or <code>conclusion</code> that you specify. For example, a conclusion can be <code>success</code> or a status can be <code>in_progress</code>. Only GitHub can set a status of <code>waiting</code> or <code>requested</code>. For a list of the possible <code>status</code> and <code>conclusion</code> options, see \"<a href=\"https://docs.github.com/rest/reference/checks#create-a-check-run\">Create a check run</a>.\"</p>"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "per_page",
|
"name": "per_page",
|
||||||
|
|
@ -34307,18 +34317,28 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "status",
|
"name": "status",
|
||||||
"description": "Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in \"[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run).\"",
|
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run).\"",
|
||||||
"in": "query",
|
"in": "query",
|
||||||
"required": false,
|
"required": false,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"completed",
|
"completed",
|
||||||
"status",
|
"action_required",
|
||||||
"conclusion"
|
"cancelled",
|
||||||
|
"failure",
|
||||||
|
"neutral",
|
||||||
|
"skipped",
|
||||||
|
"stale",
|
||||||
|
"success",
|
||||||
|
"timed_out",
|
||||||
|
"in_progress",
|
||||||
|
"queued",
|
||||||
|
"requested",
|
||||||
|
"waiting"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"descriptionHTML": "<p>Returns workflow runs associated with the check run <code>status</code> or <code>conclusion</code> you specify. For example, a conclusion can be <code>success</code> or a status can be <code>completed</code>. For more information, see the <code>status</code> and <code>conclusion</code> options available in \"<a href=\"https://docs.github.com/rest/reference/checks#create-a-check-run\">Create a check run</a>.\"</p>"
|
"descriptionHTML": "<p>Returns workflow runs with the check run <code>status</code> or <code>conclusion</code> that you specify. For example, a conclusion can be <code>success</code> or a status can be <code>in_progress</code>. Only GitHub can set a status of <code>waiting</code> or <code>requested</code>. For a list of the possible <code>status</code> and <code>conclusion</code> options, see \"<a href=\"https://docs.github.com/rest/reference/checks#create-a-check-run\">Create a check run</a>.\"</p>"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "per_page",
|
"name": "per_page",
|
||||||
|
|
@ -39887,20 +39907,21 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -40964,20 +40985,21 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -42045,20 +42067,21 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -43073,20 +43096,21 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -23969,20 +23969,21 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -25053,20 +25054,21 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -26141,20 +26143,21 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -27176,20 +27179,21 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -24536,20 +24536,21 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -25620,20 +25621,21 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -26708,20 +26710,21 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -27743,20 +27746,21 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -25007,20 +25007,21 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -26091,20 +26092,21 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -27179,20 +27181,21 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -28214,20 +28217,21 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -28474,20 +28474,21 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -29558,20 +29559,21 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -30646,20 +30648,21 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -31681,20 +31684,21 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -5591,6 +5591,134 @@
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"verb": "put",
|
||||||
|
"requestPath": "/app/installations/{installation_id}/suspended",
|
||||||
|
"serverUrl": "https://api.github.com",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "installation_id",
|
||||||
|
"description": "installation_id parameter",
|
||||||
|
"in": "path",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
|
"descriptionHTML": "<p>installation_id parameter</p>"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"x-codeSamples": [
|
||||||
|
{
|
||||||
|
"lang": "Shell",
|
||||||
|
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended",
|
||||||
|
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended</code></pre>"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"lang": "JavaScript",
|
||||||
|
"source": "await octokit.request('PUT /app/installations/{installation_id}/suspended', {\n installation_id: 42\n})",
|
||||||
|
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PUT /app/installations/{installation_id}/suspended'</span>, {\n <span class=\"hljs-attr\">installation_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"summary": "Suspend an app installation",
|
||||||
|
"description": "**Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"[Suspending a GitHub App installation](https://docs.github.com/enterprise-server@2.22/apps/managing-github-apps/suspending-a-github-app-installation/).\"\n\nSuspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
|
||||||
|
"tags": [
|
||||||
|
"apps"
|
||||||
|
],
|
||||||
|
"operationId": "apps/suspend-installation",
|
||||||
|
"externalDocs": {
|
||||||
|
"description": "API method documentation",
|
||||||
|
"url": "https://docs.github.com/enterprise-server@2.22/v3/apps/#suspend-an-app-installation"
|
||||||
|
},
|
||||||
|
"x-github": {
|
||||||
|
"githubCloudOnly": false,
|
||||||
|
"enabledForGitHubApps": false,
|
||||||
|
"previews": [],
|
||||||
|
"category": "apps",
|
||||||
|
"subcategory": null
|
||||||
|
},
|
||||||
|
"slug": "suspend-an-app-installation",
|
||||||
|
"category": "apps",
|
||||||
|
"categoryLabel": "Apps",
|
||||||
|
"notes": [],
|
||||||
|
"responses": [
|
||||||
|
{
|
||||||
|
"httpStatusCode": "204",
|
||||||
|
"httpStatusMessage": "No Content",
|
||||||
|
"description": "Default Response"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"httpStatusCode": "404",
|
||||||
|
"httpStatusMessage": "Not Found",
|
||||||
|
"description": "Resource not found"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"bodyParameters": [],
|
||||||
|
"descriptionHTML": "<p><strong>Note:</strong> Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@2.22/apps/managing-github-apps/suspending-a-github-app-installation/\">Suspending a GitHub App installation</a>.\"</p>\n<p>Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"verb": "delete",
|
||||||
|
"requestPath": "/app/installations/{installation_id}/suspended",
|
||||||
|
"serverUrl": "https://api.github.com",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "installation_id",
|
||||||
|
"description": "installation_id parameter",
|
||||||
|
"in": "path",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
|
"descriptionHTML": "<p>installation_id parameter</p>"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"x-codeSamples": [
|
||||||
|
{
|
||||||
|
"lang": "Shell",
|
||||||
|
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended",
|
||||||
|
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended</code></pre>"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"lang": "JavaScript",
|
||||||
|
"source": "await octokit.request('DELETE /app/installations/{installation_id}/suspended', {\n installation_id: 42\n})",
|
||||||
|
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'DELETE /app/installations/{installation_id}/suspended'</span>, {\n <span class=\"hljs-attr\">installation_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"summary": "Unsuspend an app installation",
|
||||||
|
"description": "**Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"[Suspending a GitHub App installation](https://docs.github.com/enterprise-server@2.22/apps/managing-github-apps/suspending-a-github-app-installation/).\"\n\nRemoves a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
|
||||||
|
"tags": [
|
||||||
|
"apps"
|
||||||
|
],
|
||||||
|
"operationId": "apps/unsuspend-installation",
|
||||||
|
"externalDocs": {
|
||||||
|
"description": "API method documentation",
|
||||||
|
"url": "https://docs.github.com/enterprise-server@2.22/v3/apps/#unsuspend-an-app-installation"
|
||||||
|
},
|
||||||
|
"x-github": {
|
||||||
|
"githubCloudOnly": false,
|
||||||
|
"enabledForGitHubApps": false,
|
||||||
|
"previews": [],
|
||||||
|
"category": "apps",
|
||||||
|
"subcategory": null
|
||||||
|
},
|
||||||
|
"slug": "unsuspend-an-app-installation",
|
||||||
|
"category": "apps",
|
||||||
|
"categoryLabel": "Apps",
|
||||||
|
"notes": [],
|
||||||
|
"responses": [
|
||||||
|
{
|
||||||
|
"httpStatusCode": "204",
|
||||||
|
"httpStatusMessage": "No Content",
|
||||||
|
"description": "Default Response"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"httpStatusCode": "404",
|
||||||
|
"httpStatusMessage": "Not Found",
|
||||||
|
"description": "Resource not found"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"bodyParameters": [],
|
||||||
|
"descriptionHTML": "<p><strong>Note:</strong> Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@2.22/apps/managing-github-apps/suspending-a-github-app-installation/\">Suspending a GitHub App installation</a>.\"</p>\n<p>Removes a GitHub App installation suspension.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"verb": "get",
|
"verb": "get",
|
||||||
"requestPath": "/applications/grants",
|
"requestPath": "/applications/grants",
|
||||||
|
|
@ -28426,18 +28554,28 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "status",
|
"name": "status",
|
||||||
"description": "Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in \"[Create a check run](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#create-a-check-run).\"",
|
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#create-a-check-run).\"",
|
||||||
"in": "query",
|
"in": "query",
|
||||||
"required": false,
|
"required": false,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"completed",
|
"completed",
|
||||||
"status",
|
"action_required",
|
||||||
"conclusion"
|
"cancelled",
|
||||||
|
"failure",
|
||||||
|
"neutral",
|
||||||
|
"skipped",
|
||||||
|
"stale",
|
||||||
|
"success",
|
||||||
|
"timed_out",
|
||||||
|
"in_progress",
|
||||||
|
"queued",
|
||||||
|
"requested",
|
||||||
|
"waiting"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"descriptionHTML": "<p>Returns workflow runs associated with the check run <code>status</code> or <code>conclusion</code> you specify. For example, a conclusion can be <code>success</code> or a status can be <code>completed</code>. For more information, see the <code>status</code> and <code>conclusion</code> options available in \"<a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/checks#create-a-check-run\">Create a check run</a>.\"</p>"
|
"descriptionHTML": "<p>Returns workflow runs with the check run <code>status</code> or <code>conclusion</code> that you specify. For example, a conclusion can be <code>success</code> or a status can be <code>in_progress</code>. Only GitHub can set a status of <code>waiting</code> or <code>requested</code>. For a list of the possible <code>status</code> and <code>conclusion</code> options, see \"<a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/checks#create-a-check-run\">Create a check run</a>.\"</p>"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "per_page",
|
"name": "per_page",
|
||||||
|
|
@ -30044,18 +30182,28 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "status",
|
"name": "status",
|
||||||
"description": "Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in \"[Create a check run](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#create-a-check-run).\"",
|
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#create-a-check-run).\"",
|
||||||
"in": "query",
|
"in": "query",
|
||||||
"required": false,
|
"required": false,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"completed",
|
"completed",
|
||||||
"status",
|
"action_required",
|
||||||
"conclusion"
|
"cancelled",
|
||||||
|
"failure",
|
||||||
|
"neutral",
|
||||||
|
"skipped",
|
||||||
|
"stale",
|
||||||
|
"success",
|
||||||
|
"timed_out",
|
||||||
|
"in_progress",
|
||||||
|
"queued",
|
||||||
|
"requested",
|
||||||
|
"waiting"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"descriptionHTML": "<p>Returns workflow runs associated with the check run <code>status</code> or <code>conclusion</code> you specify. For example, a conclusion can be <code>success</code> or a status can be <code>completed</code>. For more information, see the <code>status</code> and <code>conclusion</code> options available in \"<a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/checks#create-a-check-run\">Create a check run</a>.\"</p>"
|
"descriptionHTML": "<p>Returns workflow runs with the check run <code>status</code> or <code>conclusion</code> that you specify. For example, a conclusion can be <code>success</code> or a status can be <code>in_progress</code>. Only GitHub can set a status of <code>waiting</code> or <code>requested</code>. For a list of the possible <code>status</code> and <code>conclusion</code> options, see \"<a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/checks#create-a-check-run\">Create a check run</a>.\"</p>"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "per_page",
|
"name": "per_page",
|
||||||
|
|
@ -35257,20 +35405,21 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -36341,20 +36490,21 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -37429,20 +37579,21 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -38464,20 +38615,21 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -5793,6 +5793,134 @@
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"verb": "put",
|
||||||
|
"requestPath": "/app/installations/{installation_id}/suspended",
|
||||||
|
"serverUrl": "https://api.github.com",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "installation_id",
|
||||||
|
"description": "installation_id parameter",
|
||||||
|
"in": "path",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
|
"descriptionHTML": "<p>installation_id parameter</p>"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"x-codeSamples": [
|
||||||
|
{
|
||||||
|
"lang": "Shell",
|
||||||
|
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended",
|
||||||
|
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended</code></pre>"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"lang": "JavaScript",
|
||||||
|
"source": "await octokit.request('PUT /app/installations/{installation_id}/suspended', {\n installation_id: 42\n})",
|
||||||
|
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PUT /app/installations/{installation_id}/suspended'</span>, {\n <span class=\"hljs-attr\">installation_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"summary": "Suspend an app installation",
|
||||||
|
"description": "**Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"[Suspending a GitHub App installation](https://docs.github.com/enterprise-server@3.0/apps/managing-github-apps/suspending-a-github-app-installation/).\"\n\nSuspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
|
||||||
|
"tags": [
|
||||||
|
"apps"
|
||||||
|
],
|
||||||
|
"operationId": "apps/suspend-installation",
|
||||||
|
"externalDocs": {
|
||||||
|
"description": "API method documentation",
|
||||||
|
"url": "https://docs.github.com/enterprise-server@3.0/v3/apps/#suspend-an-app-installation"
|
||||||
|
},
|
||||||
|
"x-github": {
|
||||||
|
"githubCloudOnly": false,
|
||||||
|
"enabledForGitHubApps": false,
|
||||||
|
"previews": [],
|
||||||
|
"category": "apps",
|
||||||
|
"subcategory": null
|
||||||
|
},
|
||||||
|
"slug": "suspend-an-app-installation",
|
||||||
|
"category": "apps",
|
||||||
|
"categoryLabel": "Apps",
|
||||||
|
"notes": [],
|
||||||
|
"responses": [
|
||||||
|
{
|
||||||
|
"httpStatusCode": "204",
|
||||||
|
"httpStatusMessage": "No Content",
|
||||||
|
"description": "Default Response"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"httpStatusCode": "404",
|
||||||
|
"httpStatusMessage": "Not Found",
|
||||||
|
"description": "Resource not found"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"bodyParameters": [],
|
||||||
|
"descriptionHTML": "<p><strong>Note:</strong> Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.0/apps/managing-github-apps/suspending-a-github-app-installation/\">Suspending a GitHub App installation</a>.\"</p>\n<p>Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"verb": "delete",
|
||||||
|
"requestPath": "/app/installations/{installation_id}/suspended",
|
||||||
|
"serverUrl": "https://api.github.com",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "installation_id",
|
||||||
|
"description": "installation_id parameter",
|
||||||
|
"in": "path",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
|
"descriptionHTML": "<p>installation_id parameter</p>"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"x-codeSamples": [
|
||||||
|
{
|
||||||
|
"lang": "Shell",
|
||||||
|
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended",
|
||||||
|
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended</code></pre>"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"lang": "JavaScript",
|
||||||
|
"source": "await octokit.request('DELETE /app/installations/{installation_id}/suspended', {\n installation_id: 42\n})",
|
||||||
|
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'DELETE /app/installations/{installation_id}/suspended'</span>, {\n <span class=\"hljs-attr\">installation_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"summary": "Unsuspend an app installation",
|
||||||
|
"description": "**Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"[Suspending a GitHub App installation](https://docs.github.com/enterprise-server@3.0/apps/managing-github-apps/suspending-a-github-app-installation/).\"\n\nRemoves a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
|
||||||
|
"tags": [
|
||||||
|
"apps"
|
||||||
|
],
|
||||||
|
"operationId": "apps/unsuspend-installation",
|
||||||
|
"externalDocs": {
|
||||||
|
"description": "API method documentation",
|
||||||
|
"url": "https://docs.github.com/enterprise-server@3.0/v3/apps/#unsuspend-an-app-installation"
|
||||||
|
},
|
||||||
|
"x-github": {
|
||||||
|
"githubCloudOnly": false,
|
||||||
|
"enabledForGitHubApps": false,
|
||||||
|
"previews": [],
|
||||||
|
"category": "apps",
|
||||||
|
"subcategory": null
|
||||||
|
},
|
||||||
|
"slug": "unsuspend-an-app-installation",
|
||||||
|
"category": "apps",
|
||||||
|
"categoryLabel": "Apps",
|
||||||
|
"notes": [],
|
||||||
|
"responses": [
|
||||||
|
{
|
||||||
|
"httpStatusCode": "204",
|
||||||
|
"httpStatusMessage": "No Content",
|
||||||
|
"description": "Default Response"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"httpStatusCode": "404",
|
||||||
|
"httpStatusMessage": "Not Found",
|
||||||
|
"description": "Resource not found"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"bodyParameters": [],
|
||||||
|
"descriptionHTML": "<p><strong>Note:</strong> Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.0/apps/managing-github-apps/suspending-a-github-app-installation/\">Suspending a GitHub App installation</a>.\"</p>\n<p>Removes a GitHub App installation suspension.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"verb": "get",
|
"verb": "get",
|
||||||
"requestPath": "/applications/grants",
|
"requestPath": "/applications/grants",
|
||||||
|
|
@ -32766,18 +32894,28 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "status",
|
"name": "status",
|
||||||
"description": "Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in \"[Create a check run](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#create-a-check-run).\"",
|
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#create-a-check-run).\"",
|
||||||
"in": "query",
|
"in": "query",
|
||||||
"required": false,
|
"required": false,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"completed",
|
"completed",
|
||||||
"status",
|
"action_required",
|
||||||
"conclusion"
|
"cancelled",
|
||||||
|
"failure",
|
||||||
|
"neutral",
|
||||||
|
"skipped",
|
||||||
|
"stale",
|
||||||
|
"success",
|
||||||
|
"timed_out",
|
||||||
|
"in_progress",
|
||||||
|
"queued",
|
||||||
|
"requested",
|
||||||
|
"waiting"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"descriptionHTML": "<p>Returns workflow runs associated with the check run <code>status</code> or <code>conclusion</code> you specify. For example, a conclusion can be <code>success</code> or a status can be <code>completed</code>. For more information, see the <code>status</code> and <code>conclusion</code> options available in \"<a href=\"https://docs.github.com/enterprise-server@3.0/rest/reference/checks#create-a-check-run\">Create a check run</a>.\"</p>"
|
"descriptionHTML": "<p>Returns workflow runs with the check run <code>status</code> or <code>conclusion</code> that you specify. For example, a conclusion can be <code>success</code> or a status can be <code>in_progress</code>. Only GitHub can set a status of <code>waiting</code> or <code>requested</code>. For a list of the possible <code>status</code> and <code>conclusion</code> options, see \"<a href=\"https://docs.github.com/enterprise-server@3.0/rest/reference/checks#create-a-check-run\">Create a check run</a>.\"</p>"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "per_page",
|
"name": "per_page",
|
||||||
|
|
@ -34556,18 +34694,28 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "status",
|
"name": "status",
|
||||||
"description": "Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in \"[Create a check run](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#create-a-check-run).\"",
|
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#create-a-check-run).\"",
|
||||||
"in": "query",
|
"in": "query",
|
||||||
"required": false,
|
"required": false,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"completed",
|
"completed",
|
||||||
"status",
|
"action_required",
|
||||||
"conclusion"
|
"cancelled",
|
||||||
|
"failure",
|
||||||
|
"neutral",
|
||||||
|
"skipped",
|
||||||
|
"stale",
|
||||||
|
"success",
|
||||||
|
"timed_out",
|
||||||
|
"in_progress",
|
||||||
|
"queued",
|
||||||
|
"requested",
|
||||||
|
"waiting"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"descriptionHTML": "<p>Returns workflow runs associated with the check run <code>status</code> or <code>conclusion</code> you specify. For example, a conclusion can be <code>success</code> or a status can be <code>completed</code>. For more information, see the <code>status</code> and <code>conclusion</code> options available in \"<a href=\"https://docs.github.com/enterprise-server@3.0/rest/reference/checks#create-a-check-run\">Create a check run</a>.\"</p>"
|
"descriptionHTML": "<p>Returns workflow runs with the check run <code>status</code> or <code>conclusion</code> that you specify. For example, a conclusion can be <code>success</code> or a status can be <code>in_progress</code>. Only GitHub can set a status of <code>waiting</code> or <code>requested</code>. For a list of the possible <code>status</code> and <code>conclusion</code> options, see \"<a href=\"https://docs.github.com/enterprise-server@3.0/rest/reference/checks#create-a-check-run\">Create a check run</a>.\"</p>"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "per_page",
|
"name": "per_page",
|
||||||
|
|
@ -39769,20 +39917,21 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -40846,20 +40995,21 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -41927,20 +42077,21 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -42955,20 +43106,21 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -4652,6 +4652,134 @@
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"verb": "put",
|
||||||
|
"requestPath": "/app/installations/{installation_id}/suspended",
|
||||||
|
"serverUrl": "https://api.github.com",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "installation_id",
|
||||||
|
"description": "installation_id parameter",
|
||||||
|
"in": "path",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
|
"descriptionHTML": "<p>installation_id parameter</p>"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"x-codeSamples": [
|
||||||
|
{
|
||||||
|
"lang": "Shell",
|
||||||
|
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended",
|
||||||
|
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended</code></pre>"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"lang": "JavaScript",
|
||||||
|
"source": "await octokit.request('PUT /app/installations/{installation_id}/suspended', {\n installation_id: 42\n})",
|
||||||
|
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PUT /app/installations/{installation_id}/suspended'</span>, {\n <span class=\"hljs-attr\">installation_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"summary": "Suspend an app installation",
|
||||||
|
"description": "**Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"[Suspending a GitHub App installation](https://docs.github.com/github-ae@latest/apps/managing-github-apps/suspending-a-github-app-installation/).\"\n\nSuspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub AE API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
|
||||||
|
"tags": [
|
||||||
|
"apps"
|
||||||
|
],
|
||||||
|
"operationId": "apps/suspend-installation",
|
||||||
|
"externalDocs": {
|
||||||
|
"description": "API method documentation",
|
||||||
|
"url": "https://docs.github.com/github-ae@latest/v3/apps/#suspend-an-app-installation"
|
||||||
|
},
|
||||||
|
"x-github": {
|
||||||
|
"githubCloudOnly": false,
|
||||||
|
"enabledForGitHubApps": false,
|
||||||
|
"previews": [],
|
||||||
|
"category": "apps",
|
||||||
|
"subcategory": null
|
||||||
|
},
|
||||||
|
"slug": "suspend-an-app-installation",
|
||||||
|
"category": "apps",
|
||||||
|
"categoryLabel": "Apps",
|
||||||
|
"notes": [],
|
||||||
|
"responses": [
|
||||||
|
{
|
||||||
|
"httpStatusCode": "204",
|
||||||
|
"httpStatusMessage": "No Content",
|
||||||
|
"description": "Default Response"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"httpStatusCode": "404",
|
||||||
|
"httpStatusMessage": "Not Found",
|
||||||
|
"description": "Resource not found"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"bodyParameters": [],
|
||||||
|
"descriptionHTML": "<p><strong>Note:</strong> Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/apps/managing-github-apps/suspending-a-github-app-installation/\">Suspending a GitHub App installation</a>.\"</p>\n<p>Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub AE API or webhook events is blocked for that account.</p>\n<p>You must use a <a href=\"https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"verb": "delete",
|
||||||
|
"requestPath": "/app/installations/{installation_id}/suspended",
|
||||||
|
"serverUrl": "https://api.github.com",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "installation_id",
|
||||||
|
"description": "installation_id parameter",
|
||||||
|
"in": "path",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
|
"descriptionHTML": "<p>installation_id parameter</p>"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"x-codeSamples": [
|
||||||
|
{
|
||||||
|
"lang": "Shell",
|
||||||
|
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended",
|
||||||
|
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app/installations/42/suspended</code></pre>"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"lang": "JavaScript",
|
||||||
|
"source": "await octokit.request('DELETE /app/installations/{installation_id}/suspended', {\n installation_id: 42\n})",
|
||||||
|
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'DELETE /app/installations/{installation_id}/suspended'</span>, {\n <span class=\"hljs-attr\">installation_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"summary": "Unsuspend an app installation",
|
||||||
|
"description": "**Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"[Suspending a GitHub App installation](https://docs.github.com/github-ae@latest/apps/managing-github-apps/suspending-a-github-app-installation/).\"\n\nRemoves a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
|
||||||
|
"tags": [
|
||||||
|
"apps"
|
||||||
|
],
|
||||||
|
"operationId": "apps/unsuspend-installation",
|
||||||
|
"externalDocs": {
|
||||||
|
"description": "API method documentation",
|
||||||
|
"url": "https://docs.github.com/github-ae@latest/v3/apps/#unsuspend-an-app-installation"
|
||||||
|
},
|
||||||
|
"x-github": {
|
||||||
|
"githubCloudOnly": false,
|
||||||
|
"enabledForGitHubApps": false,
|
||||||
|
"previews": [],
|
||||||
|
"category": "apps",
|
||||||
|
"subcategory": null
|
||||||
|
},
|
||||||
|
"slug": "unsuspend-an-app-installation",
|
||||||
|
"category": "apps",
|
||||||
|
"categoryLabel": "Apps",
|
||||||
|
"notes": [],
|
||||||
|
"responses": [
|
||||||
|
{
|
||||||
|
"httpStatusCode": "204",
|
||||||
|
"httpStatusMessage": "No Content",
|
||||||
|
"description": "Default Response"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"httpStatusCode": "404",
|
||||||
|
"httpStatusMessage": "Not Found",
|
||||||
|
"description": "Resource not found"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"bodyParameters": [],
|
||||||
|
"descriptionHTML": "<p><strong>Note:</strong> Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/apps/managing-github-apps/suspending-a-github-app-installation/\">Suspending a GitHub App installation</a>.\"</p>\n<p>Removes a GitHub App installation suspension.</p>\n<p>You must use a <a href=\"https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"verb": "delete",
|
"verb": "delete",
|
||||||
"requestPath": "/applications/{client_id}/grant",
|
"requestPath": "/applications/{client_id}/grant",
|
||||||
|
|
@ -26623,20 +26751,21 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -27700,20 +27829,21 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>. When the conclusion is <code>action_required</code>, additional details should be provided on the site specified by <code>details_url</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -28781,20 +28911,21 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -29809,20 +29940,21 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>success</code>, <code>failure</code>, <code>neutral</code>, <code>cancelled</code>, <code>skipped</code>, <code>timed_out</code>, or <code>action_required</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. Only GitHub can change a check run conclusion to <code>stale</code>.</p>",
|
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check. Can be one of <code>action_required</code>, <code>cancelled</code>, <code>failure</code>, <code>neutral</code>, <code>success</code>, <code>skipped</code>, <code>stale</code>, or <code>timed_out</code>.<br>\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
],
|
],
|
||||||
"name": "conclusion",
|
"name": "conclusion",
|
||||||
"in": "body",
|
"in": "body",
|
||||||
"rawType": "string",
|
"rawType": "string",
|
||||||
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"rawDescription": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"childParamsGroups": []
|
"childParamsGroups": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -109298,15 +109298,25 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "status",
|
"name": "status",
|
||||||
"description": "Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in \"[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run).\"",
|
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run).\"",
|
||||||
"in": "query",
|
"in": "query",
|
||||||
"required": false,
|
"required": false,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"completed",
|
"completed",
|
||||||
"status",
|
"action_required",
|
||||||
"conclusion"
|
"cancelled",
|
||||||
|
"failure",
|
||||||
|
"neutral",
|
||||||
|
"skipped",
|
||||||
|
"stale",
|
||||||
|
"success",
|
||||||
|
"timed_out",
|
||||||
|
"in_progress",
|
||||||
|
"queued",
|
||||||
|
"requested",
|
||||||
|
"waiting"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
@ -118400,15 +118410,25 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "status",
|
"name": "status",
|
||||||
"description": "Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in \"[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run).\"",
|
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run).\"",
|
||||||
"in": "query",
|
"in": "query",
|
||||||
"required": false,
|
"required": false,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"completed",
|
"completed",
|
||||||
"status",
|
"action_required",
|
||||||
"conclusion"
|
"cancelled",
|
||||||
|
"failure",
|
||||||
|
"neutral",
|
||||||
|
"skipped",
|
||||||
|
"stale",
|
||||||
|
"success",
|
||||||
|
"timed_out",
|
||||||
|
"in_progress",
|
||||||
|
"queued",
|
||||||
|
"requested",
|
||||||
|
"waiting"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
@ -135492,15 +135512,16 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -137142,15 +137163,16 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
|
||||||
|
|
@ -79045,15 +79045,16 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -80693,15 +80694,16 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
|
||||||
|
|
@ -81977,15 +81977,16 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -83635,15 +83636,16 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
|
||||||
|
|
@ -84083,15 +84083,16 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -85741,15 +85742,16 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
|
||||||
|
|
@ -94917,15 +94917,16 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -96575,15 +96576,16 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
|
||||||
|
|
@ -8882,6 +8882,122 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"/app/installations/{installation_id}/suspended": {
|
||||||
|
"put": {
|
||||||
|
"summary": "Suspend an app installation",
|
||||||
|
"description": "**Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"[Suspending a GitHub App installation](https://docs.github.com/enterprise-server@2.22/apps/managing-github-apps/suspending-a-github-app-installation/).\"\n\nSuspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
|
||||||
|
"tags": [
|
||||||
|
"apps"
|
||||||
|
],
|
||||||
|
"operationId": "apps/suspend-installation",
|
||||||
|
"externalDocs": {
|
||||||
|
"description": "API method documentation",
|
||||||
|
"url": "https://docs.github.com/enterprise-server@2.22/v3/apps/#suspend-an-app-installation"
|
||||||
|
},
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "installation_id",
|
||||||
|
"description": "installation_id parameter",
|
||||||
|
"in": "path",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "integer"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"204": {
|
||||||
|
"description": "Empty response"
|
||||||
|
},
|
||||||
|
"404": {
|
||||||
|
"description": "Resource Not Found",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"title": "Basic Error",
|
||||||
|
"description": "Basic Error",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"message": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"documentation_url": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"x-github": {
|
||||||
|
"githubCloudOnly": false,
|
||||||
|
"enabledForGitHubApps": false,
|
||||||
|
"previews": [
|
||||||
|
|
||||||
|
],
|
||||||
|
"category": "apps",
|
||||||
|
"subcategory": null
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"delete": {
|
||||||
|
"summary": "Unsuspend an app installation",
|
||||||
|
"description": "**Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"[Suspending a GitHub App installation](https://docs.github.com/enterprise-server@2.22/apps/managing-github-apps/suspending-a-github-app-installation/).\"\n\nRemoves a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
|
||||||
|
"tags": [
|
||||||
|
"apps"
|
||||||
|
],
|
||||||
|
"operationId": "apps/unsuspend-installation",
|
||||||
|
"externalDocs": {
|
||||||
|
"description": "API method documentation",
|
||||||
|
"url": "https://docs.github.com/enterprise-server@2.22/v3/apps/#unsuspend-an-app-installation"
|
||||||
|
},
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "installation_id",
|
||||||
|
"description": "installation_id parameter",
|
||||||
|
"in": "path",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "integer"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"204": {
|
||||||
|
"description": "Empty response"
|
||||||
|
},
|
||||||
|
"404": {
|
||||||
|
"description": "Resource Not Found",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"title": "Basic Error",
|
||||||
|
"description": "Basic Error",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"message": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"documentation_url": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"x-github": {
|
||||||
|
"githubCloudOnly": false,
|
||||||
|
"enabledForGitHubApps": false,
|
||||||
|
"previews": [
|
||||||
|
|
||||||
|
],
|
||||||
|
"category": "apps",
|
||||||
|
"subcategory": null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"/applications/grants": {
|
"/applications/grants": {
|
||||||
"get": {
|
"get": {
|
||||||
"summary": "List your grants",
|
"summary": "List your grants",
|
||||||
|
|
@ -97456,15 +97572,25 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "status",
|
"name": "status",
|
||||||
"description": "Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in \"[Create a check run](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#create-a-check-run).\"",
|
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#create-a-check-run).\"",
|
||||||
"in": "query",
|
"in": "query",
|
||||||
"required": false,
|
"required": false,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"completed",
|
"completed",
|
||||||
"status",
|
"action_required",
|
||||||
"conclusion"
|
"cancelled",
|
||||||
|
"failure",
|
||||||
|
"neutral",
|
||||||
|
"skipped",
|
||||||
|
"stale",
|
||||||
|
"success",
|
||||||
|
"timed_out",
|
||||||
|
"in_progress",
|
||||||
|
"queued",
|
||||||
|
"requested",
|
||||||
|
"waiting"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
@ -106291,15 +106417,25 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "status",
|
"name": "status",
|
||||||
"description": "Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in \"[Create a check run](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#create-a-check-run).\"",
|
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/enterprise-server@2.22/rest/reference/checks#create-a-check-run).\"",
|
||||||
"in": "query",
|
"in": "query",
|
||||||
"required": false,
|
"required": false,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"completed",
|
"completed",
|
||||||
"status",
|
"action_required",
|
||||||
"conclusion"
|
"cancelled",
|
||||||
|
"failure",
|
||||||
|
"neutral",
|
||||||
|
"skipped",
|
||||||
|
"stale",
|
||||||
|
"success",
|
||||||
|
"timed_out",
|
||||||
|
"in_progress",
|
||||||
|
"queued",
|
||||||
|
"requested",
|
||||||
|
"waiting"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
@ -121662,15 +121798,16 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -123320,15 +123457,16 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
|
||||||
|
|
@ -9096,6 +9096,122 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"/app/installations/{installation_id}/suspended": {
|
||||||
|
"put": {
|
||||||
|
"summary": "Suspend an app installation",
|
||||||
|
"description": "**Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"[Suspending a GitHub App installation](https://docs.github.com/enterprise-server@3.0/apps/managing-github-apps/suspending-a-github-app-installation/).\"\n\nSuspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
|
||||||
|
"tags": [
|
||||||
|
"apps"
|
||||||
|
],
|
||||||
|
"operationId": "apps/suspend-installation",
|
||||||
|
"externalDocs": {
|
||||||
|
"description": "API method documentation",
|
||||||
|
"url": "https://docs.github.com/enterprise-server@3.0/v3/apps/#suspend-an-app-installation"
|
||||||
|
},
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "installation_id",
|
||||||
|
"description": "installation_id parameter",
|
||||||
|
"in": "path",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "integer"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"204": {
|
||||||
|
"description": "Empty response"
|
||||||
|
},
|
||||||
|
"404": {
|
||||||
|
"description": "Resource Not Found",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"title": "Basic Error",
|
||||||
|
"description": "Basic Error",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"message": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"documentation_url": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"x-github": {
|
||||||
|
"githubCloudOnly": false,
|
||||||
|
"enabledForGitHubApps": false,
|
||||||
|
"previews": [
|
||||||
|
|
||||||
|
],
|
||||||
|
"category": "apps",
|
||||||
|
"subcategory": null
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"delete": {
|
||||||
|
"summary": "Unsuspend an app installation",
|
||||||
|
"description": "**Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"[Suspending a GitHub App installation](https://docs.github.com/enterprise-server@3.0/apps/managing-github-apps/suspending-a-github-app-installation/).\"\n\nRemoves a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
|
||||||
|
"tags": [
|
||||||
|
"apps"
|
||||||
|
],
|
||||||
|
"operationId": "apps/unsuspend-installation",
|
||||||
|
"externalDocs": {
|
||||||
|
"description": "API method documentation",
|
||||||
|
"url": "https://docs.github.com/enterprise-server@3.0/v3/apps/#unsuspend-an-app-installation"
|
||||||
|
},
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "installation_id",
|
||||||
|
"description": "installation_id parameter",
|
||||||
|
"in": "path",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "integer"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"204": {
|
||||||
|
"description": "Empty response"
|
||||||
|
},
|
||||||
|
"404": {
|
||||||
|
"description": "Resource Not Found",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"title": "Basic Error",
|
||||||
|
"description": "Basic Error",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"message": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"documentation_url": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"x-github": {
|
||||||
|
"githubCloudOnly": false,
|
||||||
|
"enabledForGitHubApps": false,
|
||||||
|
"previews": [
|
||||||
|
|
||||||
|
],
|
||||||
|
"category": "apps",
|
||||||
|
"subcategory": null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"/applications/grants": {
|
"/applications/grants": {
|
||||||
"get": {
|
"get": {
|
||||||
"summary": "List your grants",
|
"summary": "List your grants",
|
||||||
|
|
@ -102455,15 +102571,25 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "status",
|
"name": "status",
|
||||||
"description": "Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in \"[Create a check run](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#create-a-check-run).\"",
|
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#create-a-check-run).\"",
|
||||||
"in": "query",
|
"in": "query",
|
||||||
"required": false,
|
"required": false,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"completed",
|
"completed",
|
||||||
"status",
|
"action_required",
|
||||||
"conclusion"
|
"cancelled",
|
||||||
|
"failure",
|
||||||
|
"neutral",
|
||||||
|
"skipped",
|
||||||
|
"stale",
|
||||||
|
"success",
|
||||||
|
"timed_out",
|
||||||
|
"in_progress",
|
||||||
|
"queued",
|
||||||
|
"requested",
|
||||||
|
"waiting"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
@ -111414,15 +111540,25 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "status",
|
"name": "status",
|
||||||
"description": "Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in \"[Create a check run](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#create-a-check-run).\"",
|
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#create-a-check-run).\"",
|
||||||
"in": "query",
|
"in": "query",
|
||||||
"required": false,
|
"required": false,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"completed",
|
"completed",
|
||||||
"status",
|
"action_required",
|
||||||
"conclusion"
|
"cancelled",
|
||||||
|
"failure",
|
||||||
|
"neutral",
|
||||||
|
"skipped",
|
||||||
|
"stale",
|
||||||
|
"success",
|
||||||
|
"timed_out",
|
||||||
|
"in_progress",
|
||||||
|
"queued",
|
||||||
|
"requested",
|
||||||
|
"waiting"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
@ -126785,15 +126921,16 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -128435,15 +128572,16 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
|
||||||
|
|
@ -7630,6 +7630,122 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"/app/installations/{installation_id}/suspended": {
|
||||||
|
"put": {
|
||||||
|
"summary": "Suspend an app installation",
|
||||||
|
"description": "**Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"[Suspending a GitHub App installation](https://docs.github.com/github-ae@latest/apps/managing-github-apps/suspending-a-github-app-installation/).\"\n\nSuspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub AE API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
|
||||||
|
"tags": [
|
||||||
|
"apps"
|
||||||
|
],
|
||||||
|
"operationId": "apps/suspend-installation",
|
||||||
|
"externalDocs": {
|
||||||
|
"description": "API method documentation",
|
||||||
|
"url": "https://docs.github.com/github-ae@latest/v3/apps/#suspend-an-app-installation"
|
||||||
|
},
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "installation_id",
|
||||||
|
"description": "installation_id parameter",
|
||||||
|
"in": "path",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "integer"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"204": {
|
||||||
|
"description": "Empty response"
|
||||||
|
},
|
||||||
|
"404": {
|
||||||
|
"description": "Resource Not Found",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"title": "Basic Error",
|
||||||
|
"description": "Basic Error",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"message": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"documentation_url": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"x-github": {
|
||||||
|
"githubCloudOnly": false,
|
||||||
|
"enabledForGitHubApps": false,
|
||||||
|
"previews": [
|
||||||
|
|
||||||
|
],
|
||||||
|
"category": "apps",
|
||||||
|
"subcategory": null
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"delete": {
|
||||||
|
"summary": "Unsuspend an app installation",
|
||||||
|
"description": "**Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"[Suspending a GitHub App installation](https://docs.github.com/github-ae@latest/apps/managing-github-apps/suspending-a-github-app-installation/).\"\n\nRemoves a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
|
||||||
|
"tags": [
|
||||||
|
"apps"
|
||||||
|
],
|
||||||
|
"operationId": "apps/unsuspend-installation",
|
||||||
|
"externalDocs": {
|
||||||
|
"description": "API method documentation",
|
||||||
|
"url": "https://docs.github.com/github-ae@latest/v3/apps/#unsuspend-an-app-installation"
|
||||||
|
},
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "installation_id",
|
||||||
|
"description": "installation_id parameter",
|
||||||
|
"in": "path",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "integer"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"204": {
|
||||||
|
"description": "Empty response"
|
||||||
|
},
|
||||||
|
"404": {
|
||||||
|
"description": "Resource Not Found",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"title": "Basic Error",
|
||||||
|
"description": "Basic Error",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"message": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"documentation_url": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"x-github": {
|
||||||
|
"githubCloudOnly": false,
|
||||||
|
"enabledForGitHubApps": false,
|
||||||
|
"previews": [
|
||||||
|
|
||||||
|
],
|
||||||
|
"category": "apps",
|
||||||
|
"subcategory": null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"/applications/{client_id}/grant": {
|
"/applications/{client_id}/grant": {
|
||||||
"delete": {
|
"delete": {
|
||||||
"summary": "Delete an app authorization",
|
"summary": "Delete an app authorization",
|
||||||
|
|
@ -88888,15 +89004,16 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
@ -90538,15 +90655,16 @@
|
||||||
},
|
},
|
||||||
"conclusion": {
|
"conclusion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
|
"description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
|
||||||
"enum": [
|
"enum": [
|
||||||
"success",
|
"action_required",
|
||||||
|
"cancelled",
|
||||||
"failure",
|
"failure",
|
||||||
"neutral",
|
"neutral",
|
||||||
"cancelled",
|
"success",
|
||||||
"skipped",
|
"skipped",
|
||||||
"timed_out",
|
"stale",
|
||||||
"action_required"
|
"timed_out"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"completed_at": {
|
"completed_at": {
|
||||||
|
|
|
||||||
Загрузка…
Ссылка в новой задаче