diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 3b42b68c0b..8bdf109420 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -25967,7 +25967,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -25985,7 +25985,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object) description for details about how to use this parameter.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -26043,7 +26043,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#images-object) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -26074,7 +26074,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -26355,7 +26355,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -26373,7 +26373,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -26431,7 +26431,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -26833,7 +26833,7 @@ "properties": { "auto_trigger_checks": { "type": "array", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "items": { "type": "object", "properties": { diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 50680f02ff..c217c9fef7 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -18633,8 +18633,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object) - description. + descriptive details about the run. properties: title: type: string @@ -18661,8 +18660,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object) - description for details about how to use this parameter. maxItems: 50 items: type: object @@ -18717,8 +18714,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#images-object) - description for details. + pull request UI. items: type: object properties: @@ -18746,10 +18742,9 @@ paths: run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and - `description`. A maximum of three actions are accepted. See the - [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." + `description`. A maximum of three actions are accepted. To learn + more about check runs and requested actions, see "[Check runs + and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -18961,8 +18956,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object-1) - description. + descriptive details about the run. properties: title: type: string @@ -18987,8 +18981,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) - description for details. maxItems: 50 items: type: object @@ -19043,8 +19035,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) - description for details. + pull request UI. items: type: object properties: @@ -19324,9 +19315,7 @@ paths: auto_trigger_checks: type: array description: Enables or disables automatic creation of CheckSuite - events upon pushes to the repository. Enabled by default. See - the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object) - description for details. + events upon pushes to the repository. Enabled by default. items: type: object properties: diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 67b68f843d..72edbf91dc 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -196275,7 +196275,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -196293,7 +196293,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object) description for details about how to use this parameter.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -196351,7 +196351,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#images-object) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -196382,7 +196382,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -199074,7 +199074,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -199092,7 +199092,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -199150,7 +199150,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -204280,7 +204280,7 @@ "properties": { "auto_trigger_checks": { "type": "array", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "items": { "type": "object", "properties": { diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index a431c8c459..a32205bd4d 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -39699,8 +39699,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object) - description. + descriptive details about the run. properties: title: type: string @@ -39727,8 +39726,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object) - description for details about how to use this parameter. maxItems: 50 items: type: object @@ -39783,8 +39780,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#images-object) - description for details. + pull request UI. items: type: object properties: @@ -39812,10 +39808,9 @@ paths: run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and - `description`. A maximum of three actions are accepted. See the - [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." + `description`. A maximum of three actions are accepted. To learn + more about check runs and requested actions, see "[Check runs + and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -40494,8 +40489,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object-1) - description. + descriptive details about the run. properties: title: type: string @@ -40520,8 +40514,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) - description for details. maxItems: 50 items: type: object @@ -40576,8 +40568,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) - description for details. + pull request UI. items: type: object properties: @@ -41322,9 +41313,7 @@ paths: auto_trigger_checks: type: array description: Enables or disables automatic creation of CheckSuite - events upon pushes to the repository. Enabled by default. See - the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object) - description for details. + events upon pushes to the repository. Enabled by default. items: type: object properties: diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 2dcfb9d91a..1dcb5daa5b 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -199760,7 +199760,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#output-object) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -199778,7 +199778,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#annotations-object) description for details about how to use this parameter.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -199836,7 +199836,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#images-object) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -199867,7 +199867,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -202559,7 +202559,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -202577,7 +202577,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -202635,7 +202635,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -207765,7 +207765,7 @@ "properties": { "auto_trigger_checks": { "type": "array", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "items": { "type": "object", "properties": { diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index 28129fdbd4..87eecfbd83 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -41235,8 +41235,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#output-object) - description. + descriptive details about the run. properties: title: type: string @@ -41263,8 +41262,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#annotations-object) - description for details about how to use this parameter. maxItems: 50 items: type: object @@ -41319,8 +41316,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#images-object) - description for details. + pull request UI. items: type: object properties: @@ -41348,10 +41344,9 @@ paths: run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and - `description`. A maximum of three actions are accepted. See the - [`actions` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#check-runs-and-requested-actions)." + `description`. A maximum of three actions are accepted. To learn + more about check runs and requested actions, see "[Check runs + and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -42030,8 +42025,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#output-object-1) - description. + descriptive details about the run. properties: title: type: string @@ -42056,8 +42050,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#annotations-object-1) - description for details. maxItems: 50 items: type: object @@ -42112,8 +42104,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#annotations-object-1) - description for details. + pull request UI. items: type: object properties: @@ -42858,9 +42849,7 @@ paths: auto_trigger_checks: type: array description: Enables or disables automatic creation of CheckSuite - events upon pushes to the repository. Enabled by default. See - the [`auto_trigger_checks` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#auto_trigger_checks-object) - description for details. + events upon pushes to the repository. Enabled by default. items: type: object properties: diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index e76ba4f965..0954b82fb7 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -27203,7 +27203,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#output-object) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -27221,7 +27221,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#annotations-object) description for details about how to use this parameter.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -27279,7 +27279,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#images-object) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -27310,7 +27310,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -27591,7 +27591,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -27609,7 +27609,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -27667,7 +27667,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -28069,7 +28069,7 @@ "properties": { "auto_trigger_checks": { "type": "array", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "items": { "type": "object", "properties": { diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index c632803c99..b8df587154 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -19495,8 +19495,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#output-object) - description. + descriptive details about the run. properties: title: type: string @@ -19523,8 +19522,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#annotations-object) - description for details about how to use this parameter. maxItems: 50 items: type: object @@ -19579,8 +19576,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#images-object) - description for details. + pull request UI. items: type: object properties: @@ -19608,10 +19604,9 @@ paths: run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and - `description`. A maximum of three actions are accepted. See the - [`actions` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#check-runs-and-requested-actions)." + `description`. A maximum of three actions are accepted. To learn + more about check runs and requested actions, see "[Check runs + and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -19823,8 +19818,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#output-object-1) - description. + descriptive details about the run. properties: title: type: string @@ -19849,8 +19843,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#annotations-object-1) - description for details. maxItems: 50 items: type: object @@ -19905,8 +19897,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#annotations-object-1) - description for details. + pull request UI. items: type: object properties: @@ -20186,9 +20177,7 @@ paths: auto_trigger_checks: type: array description: Enables or disables automatic creation of CheckSuite - events upon pushes to the repository. Enabled by default. See - the [`auto_trigger_checks` object](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#auto_trigger_checks-object) - description for details. + events upon pushes to the repository. Enabled by default. items: type: object properties: diff --git a/descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.json b/descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.json index a6220e5a78..54afba6143 100644 --- a/descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.json +++ b/descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.json @@ -163147,7 +163147,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#output-object) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -163165,7 +163165,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object) description for details about how to use this parameter.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -163223,7 +163223,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#images-object) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -163254,7 +163254,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -165946,7 +165946,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -165964,7 +165964,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -166022,7 +166022,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -170986,7 +170986,7 @@ "properties": { "auto_trigger_checks": { "type": "array", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "items": { "type": "object", "properties": { diff --git a/descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.yaml b/descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.yaml index 6642a85d89..88115857fa 100644 --- a/descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.yaml +++ b/descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.yaml @@ -34155,8 +34155,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#output-object) - description. + descriptive details about the run. properties: title: type: string @@ -34183,8 +34182,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object) - description for details about how to use this parameter. maxItems: 50 items: type: object @@ -34239,8 +34236,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#images-object) - description for details. + pull request UI. items: type: object properties: @@ -34268,10 +34264,9 @@ paths: run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and - `description`. A maximum of three actions are accepted. See the - [`actions` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#check-runs-and-requested-actions)." + `description`. A maximum of three actions are accepted. To learn + more about check runs and requested actions, see "[Check runs + and requested actions](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -34950,8 +34945,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#output-object-1) - description. + descriptive details about the run. properties: title: type: string @@ -34976,8 +34970,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object-1) - description for details. maxItems: 50 items: type: object @@ -35032,8 +35024,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object-1) - description for details. + pull request UI. items: type: object properties: @@ -35735,9 +35726,7 @@ paths: auto_trigger_checks: type: array description: Enables or disables automatic creation of CheckSuite - events upon pushes to the repository. Enabled by default. See - the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#auto_trigger_checks-object) - description for details. + events upon pushes to the repository. Enabled by default. items: type: object properties: diff --git a/descriptions-next/ghes-3.2/ghes-3.2.json b/descriptions-next/ghes-3.2/ghes-3.2.json index f9e5789d43..38c54c629e 100644 --- a/descriptions-next/ghes-3.2/ghes-3.2.json +++ b/descriptions-next/ghes-3.2/ghes-3.2.json @@ -23373,7 +23373,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#output-object) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -23391,7 +23391,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object) description for details about how to use this parameter.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -23449,7 +23449,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#images-object) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -23480,7 +23480,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -23761,7 +23761,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -23779,7 +23779,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -23837,7 +23837,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -24170,7 +24170,7 @@ "properties": { "auto_trigger_checks": { "type": "array", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "items": { "type": "object", "properties": { diff --git a/descriptions-next/ghes-3.2/ghes-3.2.yaml b/descriptions-next/ghes-3.2/ghes-3.2.yaml index 2ec6934e22..ca6c55b90d 100644 --- a/descriptions-next/ghes-3.2/ghes-3.2.yaml +++ b/descriptions-next/ghes-3.2/ghes-3.2.yaml @@ -16874,8 +16874,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#output-object) - description. + descriptive details about the run. properties: title: type: string @@ -16902,8 +16901,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object) - description for details about how to use this parameter. maxItems: 50 items: type: object @@ -16958,8 +16955,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#images-object) - description for details. + pull request UI. items: type: object properties: @@ -16987,10 +16983,9 @@ paths: run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and - `description`. A maximum of three actions are accepted. See the - [`actions` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#check-runs-and-requested-actions)." + `description`. A maximum of three actions are accepted. To learn + more about check runs and requested actions, see "[Check runs + and requested actions](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -17202,8 +17197,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#output-object-1) - description. + descriptive details about the run. properties: title: type: string @@ -17228,8 +17222,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object-1) - description for details. maxItems: 50 items: type: object @@ -17284,8 +17276,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object-1) - description for details. + pull request UI. items: type: object properties: @@ -17519,9 +17510,7 @@ paths: auto_trigger_checks: type: array description: Enables or disables automatic creation of CheckSuite - events upon pushes to the repository. Enabled by default. See - the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#auto_trigger_checks-object) - description for details. + events upon pushes to the repository. Enabled by default. items: type: object properties: diff --git a/descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.json b/descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.json index 09f3cb1400..c3693879aa 100644 --- a/descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.json +++ b/descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.json @@ -165020,7 +165020,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#output-object) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -165038,7 +165038,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object) description for details about how to use this parameter.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -165096,7 +165096,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#images-object) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -165127,7 +165127,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -167819,7 +167819,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -167837,7 +167837,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -167895,7 +167895,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -173007,7 +173007,7 @@ "properties": { "auto_trigger_checks": { "type": "array", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "items": { "type": "object", "properties": { diff --git a/descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.yaml b/descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.yaml index ee4d63cdff..3f09fa1187 100644 --- a/descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.yaml +++ b/descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.yaml @@ -34712,8 +34712,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#output-object) - description. + descriptive details about the run. properties: title: type: string @@ -34740,8 +34739,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object) - description for details about how to use this parameter. maxItems: 50 items: type: object @@ -34796,8 +34793,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#images-object) - description for details. + pull request UI. items: type: object properties: @@ -34825,10 +34821,9 @@ paths: run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and - `description`. A maximum of three actions are accepted. See the - [`actions` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#check-runs-and-requested-actions)." + `description`. A maximum of three actions are accepted. To learn + more about check runs and requested actions, see "[Check runs + and requested actions](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -35507,8 +35502,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#output-object-1) - description. + descriptive details about the run. properties: title: type: string @@ -35533,8 +35527,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object-1) - description for details. maxItems: 50 items: type: object @@ -35589,8 +35581,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object-1) - description for details. + pull request UI. items: type: object properties: @@ -36342,9 +36333,7 @@ paths: auto_trigger_checks: type: array description: Enables or disables automatic creation of CheckSuite - events upon pushes to the repository. Enabled by default. See - the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#auto_trigger_checks-object) - description for details. + events upon pushes to the repository. Enabled by default. items: type: object properties: diff --git a/descriptions-next/ghes-3.3/ghes-3.3.json b/descriptions-next/ghes-3.3/ghes-3.3.json index 3d71d0309f..69a564da81 100644 --- a/descriptions-next/ghes-3.3/ghes-3.3.json +++ b/descriptions-next/ghes-3.3/ghes-3.3.json @@ -23223,7 +23223,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#output-object) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -23241,7 +23241,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object) description for details about how to use this parameter.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -23299,7 +23299,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#images-object) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -23330,7 +23330,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -23611,7 +23611,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -23629,7 +23629,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -23687,7 +23687,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -24096,7 +24096,7 @@ "properties": { "auto_trigger_checks": { "type": "array", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "items": { "type": "object", "properties": { diff --git a/descriptions-next/ghes-3.3/ghes-3.3.yaml b/descriptions-next/ghes-3.3/ghes-3.3.yaml index 5a6b5b3c8b..956fde3f7e 100644 --- a/descriptions-next/ghes-3.3/ghes-3.3.yaml +++ b/descriptions-next/ghes-3.3/ghes-3.3.yaml @@ -16381,8 +16381,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#output-object) - description. + descriptive details about the run. properties: title: type: string @@ -16409,8 +16408,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object) - description for details about how to use this parameter. maxItems: 50 items: type: object @@ -16465,8 +16462,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#images-object) - description for details. + pull request UI. items: type: object properties: @@ -16494,10 +16490,9 @@ paths: run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and - `description`. A maximum of three actions are accepted. See the - [`actions` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#check-runs-and-requested-actions)." + `description`. A maximum of three actions are accepted. To learn + more about check runs and requested actions, see "[Check runs + and requested actions](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -16709,8 +16704,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#output-object-1) - description. + descriptive details about the run. properties: title: type: string @@ -16735,8 +16729,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object-1) - description for details. maxItems: 50 items: type: object @@ -16791,8 +16783,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object-1) - description for details. + pull request UI. items: type: object properties: @@ -17080,9 +17071,7 @@ paths: auto_trigger_checks: type: array description: Enables or disables automatic creation of CheckSuite - events upon pushes to the repository. Enabled by default. See - the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#auto_trigger_checks-object) - description for details. + events upon pushes to the repository. Enabled by default. items: type: object properties: diff --git a/descriptions-next/ghes-3.4/dereferenced/ghes-3.4.deref.json b/descriptions-next/ghes-3.4/dereferenced/ghes-3.4.deref.json index f14c91b296..be7070a899 100644 --- a/descriptions-next/ghes-3.4/dereferenced/ghes-3.4.deref.json +++ b/descriptions-next/ghes-3.4/dereferenced/ghes-3.4.deref.json @@ -179999,7 +179999,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#output-object) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -180017,7 +180017,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object) description for details about how to use this parameter.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -180075,7 +180075,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#images-object) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -180106,7 +180106,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -182798,7 +182798,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -182816,7 +182816,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -182874,7 +182874,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -187980,7 +187980,7 @@ "properties": { "auto_trigger_checks": { "type": "array", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "items": { "type": "object", "properties": { diff --git a/descriptions-next/ghes-3.4/dereferenced/ghes-3.4.deref.yaml b/descriptions-next/ghes-3.4/dereferenced/ghes-3.4.deref.yaml index 4a43cc5567..afbd21231b 100644 --- a/descriptions-next/ghes-3.4/dereferenced/ghes-3.4.deref.yaml +++ b/descriptions-next/ghes-3.4/dereferenced/ghes-3.4.deref.yaml @@ -36824,8 +36824,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#output-object) - description. + descriptive details about the run. properties: title: type: string @@ -36852,8 +36851,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object) - description for details about how to use this parameter. maxItems: 50 items: type: object @@ -36908,8 +36905,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#images-object) - description for details. + pull request UI. items: type: object properties: @@ -36937,10 +36933,9 @@ paths: run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and - `description`. A maximum of three actions are accepted. See the - [`actions` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#check-runs-and-requested-actions)." + `description`. A maximum of three actions are accepted. To learn + more about check runs and requested actions, see "[Check runs + and requested actions](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -37619,8 +37614,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#output-object-1) - description. + descriptive details about the run. properties: title: type: string @@ -37645,8 +37639,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object-1) - description for details. maxItems: 50 items: type: object @@ -37701,8 +37693,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object-1) - description for details. + pull request UI. items: type: object properties: @@ -38447,9 +38438,7 @@ paths: auto_trigger_checks: type: array description: Enables or disables automatic creation of CheckSuite - events upon pushes to the repository. Enabled by default. See - the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#auto_trigger_checks-object) - description for details. + events upon pushes to the repository. Enabled by default. items: type: object properties: diff --git a/descriptions-next/ghes-3.4/ghes-3.4.json b/descriptions-next/ghes-3.4/ghes-3.4.json index 8ffcb2eba5..f3c7c7443f 100644 --- a/descriptions-next/ghes-3.4/ghes-3.4.json +++ b/descriptions-next/ghes-3.4/ghes-3.4.json @@ -24923,7 +24923,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#output-object) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -24941,7 +24941,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object) description for details about how to use this parameter.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -24999,7 +24999,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#images-object) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -25030,7 +25030,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -25311,7 +25311,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -25329,7 +25329,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -25387,7 +25387,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -25789,7 +25789,7 @@ "properties": { "auto_trigger_checks": { "type": "array", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "items": { "type": "object", "properties": { diff --git a/descriptions-next/ghes-3.4/ghes-3.4.yaml b/descriptions-next/ghes-3.4/ghes-3.4.yaml index c00be6b735..99e1b36e69 100644 --- a/descriptions-next/ghes-3.4/ghes-3.4.yaml +++ b/descriptions-next/ghes-3.4/ghes-3.4.yaml @@ -17709,8 +17709,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#output-object) - description. + descriptive details about the run. properties: title: type: string @@ -17737,8 +17736,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object) - description for details about how to use this parameter. maxItems: 50 items: type: object @@ -17793,8 +17790,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#images-object) - description for details. + pull request UI. items: type: object properties: @@ -17822,10 +17818,9 @@ paths: run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and - `description`. A maximum of three actions are accepted. See the - [`actions` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#check-runs-and-requested-actions)." + `description`. A maximum of three actions are accepted. To learn + more about check runs and requested actions, see "[Check runs + and requested actions](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -18037,8 +18032,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#output-object-1) - description. + descriptive details about the run. properties: title: type: string @@ -18063,8 +18057,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object-1) - description for details. maxItems: 50 items: type: object @@ -18119,8 +18111,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object-1) - description for details. + pull request UI. items: type: object properties: @@ -18400,9 +18391,7 @@ paths: auto_trigger_checks: type: array description: Enables or disables automatic creation of CheckSuite - events upon pushes to the repository. Enabled by default. See - the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#auto_trigger_checks-object) - description for details. + events upon pushes to the repository. Enabled by default. items: type: object properties: diff --git a/descriptions-next/ghes-3.5/dereferenced/ghes-3.5.deref.json b/descriptions-next/ghes-3.5/dereferenced/ghes-3.5.deref.json index 2bc718fa36..2182d880a6 100644 --- a/descriptions-next/ghes-3.5/dereferenced/ghes-3.5.deref.json +++ b/descriptions-next/ghes-3.5/dereferenced/ghes-3.5.deref.json @@ -187150,7 +187150,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#output-object) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -187168,7 +187168,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object) description for details about how to use this parameter.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -187226,7 +187226,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#images-object) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -187257,7 +187257,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -189949,7 +189949,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -189967,7 +189967,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -190025,7 +190025,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -195143,7 +195143,7 @@ "properties": { "auto_trigger_checks": { "type": "array", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "items": { "type": "object", "properties": { diff --git a/descriptions-next/ghes-3.5/dereferenced/ghes-3.5.deref.yaml b/descriptions-next/ghes-3.5/dereferenced/ghes-3.5.deref.yaml index a394c42381..d3f7b59d87 100644 --- a/descriptions-next/ghes-3.5/dereferenced/ghes-3.5.deref.yaml +++ b/descriptions-next/ghes-3.5/dereferenced/ghes-3.5.deref.yaml @@ -38283,8 +38283,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#output-object) - description. + descriptive details about the run. properties: title: type: string @@ -38311,8 +38310,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object) - description for details about how to use this parameter. maxItems: 50 items: type: object @@ -38367,8 +38364,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#images-object) - description for details. + pull request UI. items: type: object properties: @@ -38396,10 +38392,9 @@ paths: run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and - `description`. A maximum of three actions are accepted. See the - [`actions` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#check-runs-and-requested-actions)." + `description`. A maximum of three actions are accepted. To learn + more about check runs and requested actions, see "[Check runs + and requested actions](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -39078,8 +39073,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#output-object-1) - description. + descriptive details about the run. properties: title: type: string @@ -39104,8 +39098,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object-1) - description for details. maxItems: 50 items: type: object @@ -39160,8 +39152,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object-1) - description for details. + pull request UI. items: type: object properties: @@ -39906,9 +39897,7 @@ paths: auto_trigger_checks: type: array description: Enables or disables automatic creation of CheckSuite - events upon pushes to the repository. Enabled by default. See - the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#auto_trigger_checks-object) - description for details. + events upon pushes to the repository. Enabled by default. items: type: object properties: diff --git a/descriptions-next/ghes-3.5/ghes-3.5.json b/descriptions-next/ghes-3.5/ghes-3.5.json index 5d78d1b9cc..f1047e6846 100644 --- a/descriptions-next/ghes-3.5/ghes-3.5.json +++ b/descriptions-next/ghes-3.5/ghes-3.5.json @@ -25940,7 +25940,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#output-object) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -25958,7 +25958,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object) description for details about how to use this parameter.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -26016,7 +26016,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#images-object) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -26047,7 +26047,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -26328,7 +26328,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -26346,7 +26346,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -26404,7 +26404,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -26806,7 +26806,7 @@ "properties": { "auto_trigger_checks": { "type": "array", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "items": { "type": "object", "properties": { diff --git a/descriptions-next/ghes-3.5/ghes-3.5.yaml b/descriptions-next/ghes-3.5/ghes-3.5.yaml index 15e61a3dac..ec986a8073 100644 --- a/descriptions-next/ghes-3.5/ghes-3.5.yaml +++ b/descriptions-next/ghes-3.5/ghes-3.5.yaml @@ -18419,8 +18419,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#output-object) - description. + descriptive details about the run. properties: title: type: string @@ -18447,8 +18446,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object) - description for details about how to use this parameter. maxItems: 50 items: type: object @@ -18503,8 +18500,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#images-object) - description for details. + pull request UI. items: type: object properties: @@ -18532,10 +18528,9 @@ paths: run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and - `description`. A maximum of three actions are accepted. See the - [`actions` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#check-runs-and-requested-actions)." + `description`. A maximum of three actions are accepted. To learn + more about check runs and requested actions, see "[Check runs + and requested actions](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -18747,8 +18742,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#output-object-1) - description. + descriptive details about the run. properties: title: type: string @@ -18773,8 +18767,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object-1) - description for details. maxItems: 50 items: type: object @@ -18829,8 +18821,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object-1) - description for details. + pull request UI. items: type: object properties: @@ -19110,9 +19101,7 @@ paths: auto_trigger_checks: type: array description: Enables or disables automatic creation of CheckSuite - events upon pushes to the repository. Enabled by default. See - the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#auto_trigger_checks-object) - description for details. + events upon pushes to the repository. Enabled by default. items: type: object properties: diff --git a/descriptions-next/ghes-3.6/dereferenced/ghes-3.6.deref.json b/descriptions-next/ghes-3.6/dereferenced/ghes-3.6.deref.json index 6228f1f8ee..eb0662844f 100644 --- a/descriptions-next/ghes-3.6/dereferenced/ghes-3.6.deref.json +++ b/descriptions-next/ghes-3.6/dereferenced/ghes-3.6.deref.json @@ -191184,7 +191184,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#output-object) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -191202,7 +191202,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object) description for details about how to use this parameter.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -191260,7 +191260,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#images-object) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -191291,7 +191291,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -193983,7 +193983,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -194001,7 +194001,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -194059,7 +194059,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -199189,7 +199189,7 @@ "properties": { "auto_trigger_checks": { "type": "array", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "items": { "type": "object", "properties": { diff --git a/descriptions-next/ghes-3.6/dereferenced/ghes-3.6.deref.yaml b/descriptions-next/ghes-3.6/dereferenced/ghes-3.6.deref.yaml index 809f739095..8dfe9d0a5d 100644 --- a/descriptions-next/ghes-3.6/dereferenced/ghes-3.6.deref.yaml +++ b/descriptions-next/ghes-3.6/dereferenced/ghes-3.6.deref.yaml @@ -39064,8 +39064,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#output-object) - description. + descriptive details about the run. properties: title: type: string @@ -39092,8 +39091,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object) - description for details about how to use this parameter. maxItems: 50 items: type: object @@ -39148,8 +39145,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#images-object) - description for details. + pull request UI. items: type: object properties: @@ -39177,10 +39173,9 @@ paths: run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and - `description`. A maximum of three actions are accepted. See the - [`actions` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#check-runs-and-requested-actions)." + `description`. A maximum of three actions are accepted. To learn + more about check runs and requested actions, see "[Check runs + and requested actions](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -39859,8 +39854,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#output-object-1) - description. + descriptive details about the run. properties: title: type: string @@ -39885,8 +39879,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object-1) - description for details. maxItems: 50 items: type: object @@ -39941,8 +39933,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object-1) - description for details. + pull request UI. items: type: object properties: @@ -40687,9 +40678,7 @@ paths: auto_trigger_checks: type: array description: Enables or disables automatic creation of CheckSuite - events upon pushes to the repository. Enabled by default. See - the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#auto_trigger_checks-object) - description for details. + events upon pushes to the repository. Enabled by default. items: type: object properties: diff --git a/descriptions-next/ghes-3.6/ghes-3.6.json b/descriptions-next/ghes-3.6/ghes-3.6.json index f78c00ce8e..ff632d29b4 100644 --- a/descriptions-next/ghes-3.6/ghes-3.6.json +++ b/descriptions-next/ghes-3.6/ghes-3.6.json @@ -26430,7 +26430,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#output-object) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -26448,7 +26448,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object) description for details about how to use this parameter.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -26506,7 +26506,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#images-object) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -26537,7 +26537,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -26818,7 +26818,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -26836,7 +26836,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -26894,7 +26894,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -27296,7 +27296,7 @@ "properties": { "auto_trigger_checks": { "type": "array", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "items": { "type": "object", "properties": { diff --git a/descriptions-next/ghes-3.6/ghes-3.6.yaml b/descriptions-next/ghes-3.6/ghes-3.6.yaml index a93465649d..2c32ea81f7 100644 --- a/descriptions-next/ghes-3.6/ghes-3.6.yaml +++ b/descriptions-next/ghes-3.6/ghes-3.6.yaml @@ -18774,8 +18774,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#output-object) - description. + descriptive details about the run. properties: title: type: string @@ -18802,8 +18801,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object) - description for details about how to use this parameter. maxItems: 50 items: type: object @@ -18858,8 +18855,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#images-object) - description for details. + pull request UI. items: type: object properties: @@ -18887,10 +18883,9 @@ paths: run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and - `description`. A maximum of three actions are accepted. See the - [`actions` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#check-runs-and-requested-actions)." + `description`. A maximum of three actions are accepted. To learn + more about check runs and requested actions, see "[Check runs + and requested actions](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -19102,8 +19097,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#output-object-1) - description. + descriptive details about the run. properties: title: type: string @@ -19128,8 +19122,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object-1) - description for details. maxItems: 50 items: type: object @@ -19184,8 +19176,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object-1) - description for details. + pull request UI. items: type: object properties: @@ -19465,9 +19456,7 @@ paths: auto_trigger_checks: type: array description: Enables or disables automatic creation of CheckSuite - events upon pushes to the repository. Enabled by default. See - the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#auto_trigger_checks-object) - description for details. + events upon pushes to the repository. Enabled by default. items: type: object properties: diff --git a/descriptions-next/github.ae/dereferenced/github.ae.deref.json b/descriptions-next/github.ae/dereferenced/github.ae.deref.json index b27f0259b8..6a00785f9d 100644 --- a/descriptions-next/github.ae/dereferenced/github.ae.deref.json +++ b/descriptions-next/github.ae/dereferenced/github.ae.deref.json @@ -148677,7 +148677,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/github-ae@latest/rest/reference/checks#output-object) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -148695,7 +148695,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object) description for details about how to use this parameter.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -148753,7 +148753,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/github-ae@latest/rest/reference/checks#images-object) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -148784,7 +148784,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/github-ae@latest/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/github-ae@latest/rest/reference/checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/github-ae@latest/rest/reference/checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -151476,7 +151476,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/github-ae@latest/rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -151494,7 +151494,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -151552,7 +151552,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -156682,7 +156682,7 @@ "properties": { "auto_trigger_checks": { "type": "array", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/github-ae@latest/rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "items": { "type": "object", "properties": { diff --git a/descriptions-next/github.ae/dereferenced/github.ae.deref.yaml b/descriptions-next/github.ae/dereferenced/github.ae.deref.yaml index 688aef4476..1bd0c73a3d 100644 --- a/descriptions-next/github.ae/dereferenced/github.ae.deref.yaml +++ b/descriptions-next/github.ae/dereferenced/github.ae.deref.yaml @@ -32003,8 +32003,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/github-ae@latest/rest/reference/checks#output-object) - description. + descriptive details about the run. properties: title: type: string @@ -32031,8 +32030,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object) - description for details about how to use this parameter. maxItems: 50 items: type: object @@ -32087,8 +32084,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/github-ae@latest/rest/reference/checks#images-object) - description for details. + pull request UI. items: type: object properties: @@ -32116,10 +32112,9 @@ paths: run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and - `description`. A maximum of three actions are accepted. See the - [`actions` object](https://docs.github.com/github-ae@latest/rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/github-ae@latest/rest/reference/checks#check-runs-and-requested-actions)." + `description`. A maximum of three actions are accepted. To learn + more about check runs and requested actions, see "[Check runs + and requested actions](https://docs.github.com/github-ae@latest/rest/reference/checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -32798,8 +32793,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/github-ae@latest/rest/reference/checks#output-object-1) - description. + descriptive details about the run. properties: title: type: string @@ -32824,8 +32818,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object-1) - description for details. maxItems: 50 items: type: object @@ -32880,8 +32872,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object-1) - description for details. + pull request UI. items: type: object properties: @@ -33626,9 +33617,7 @@ paths: auto_trigger_checks: type: array description: Enables or disables automatic creation of CheckSuite - events upon pushes to the repository. Enabled by default. See - the [`auto_trigger_checks` object](https://docs.github.com/github-ae@latest/rest/reference/checks#auto_trigger_checks-object) - description for details. + events upon pushes to the repository. Enabled by default. items: type: object properties: diff --git a/descriptions-next/github.ae/github.ae.json b/descriptions-next/github.ae/github.ae.json index 3d862462db..9646a16a48 100644 --- a/descriptions-next/github.ae/github.ae.json +++ b/descriptions-next/github.ae/github.ae.json @@ -20778,7 +20778,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/github-ae@latest/rest/reference/checks#output-object) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -20796,7 +20796,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object) description for details about how to use this parameter.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -20854,7 +20854,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/github-ae@latest/rest/reference/checks#images-object) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -20885,7 +20885,7 @@ }, "actions": { "type": "array", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/github-ae@latest/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/github-ae@latest/rest/reference/checks#check-runs-and-requested-actions).\"", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/github-ae@latest/rest/reference/checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -21166,7 +21166,7 @@ }, "output": { "type": "object", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/github-ae@latest/rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "properties": { "title": { "type": "string", @@ -21184,7 +21184,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -21242,7 +21242,7 @@ }, "images": { "type": "array", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "items": { "type": "object", "properties": { @@ -21644,7 +21644,7 @@ "properties": { "auto_trigger_checks": { "type": "array", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/github-ae@latest/rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "items": { "type": "object", "properties": { diff --git a/descriptions-next/github.ae/github.ae.yaml b/descriptions-next/github.ae/github.ae.yaml index abc03caba5..1ce37c06b1 100644 --- a/descriptions-next/github.ae/github.ae.yaml +++ b/descriptions-next/github.ae/github.ae.yaml @@ -14764,8 +14764,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/github-ae@latest/rest/reference/checks#output-object) - description. + descriptive details about the run. properties: title: type: string @@ -14792,8 +14791,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object) - description for details about how to use this parameter. maxItems: 50 items: type: object @@ -14848,8 +14845,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/github-ae@latest/rest/reference/checks#images-object) - description for details. + pull request UI. items: type: object properties: @@ -14877,10 +14873,9 @@ paths: run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and - `description`. A maximum of three actions are accepted. See the - [`actions` object](https://docs.github.com/github-ae@latest/rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/github-ae@latest/rest/reference/checks#check-runs-and-requested-actions)." + `description`. A maximum of three actions are accepted. To learn + more about check runs and requested actions, see "[Check runs + and requested actions](https://docs.github.com/github-ae@latest/rest/reference/checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -15092,8 +15087,7 @@ paths: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide - descriptive details about the run. See the [`output` object](https://docs.github.com/github-ae@latest/rest/reference/checks#output-object-1) - description. + descriptive details about the run. properties: title: type: string @@ -15118,8 +15112,6 @@ paths: are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - See the [`annotations` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object-1) - description for details. maxItems: 50 items: type: object @@ -15174,8 +15166,7 @@ paths: images: type: array description: Adds images to the output displayed in the GitHub - pull request UI. See the [`images` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object-1) - description for details. + pull request UI. items: type: object properties: @@ -15455,9 +15446,7 @@ paths: auto_trigger_checks: type: array description: Enables or disables automatic creation of CheckSuite - events upon pushes to the repository. Enabled by default. See - the [`auto_trigger_checks` object](https://docs.github.com/github-ae@latest/rest/reference/checks#auto_trigger_checks-object) - description for details. + events upon pushes to the repository. Enabled by default. items: type: object properties: