Skip to content

Commit fc50395

Browse files
Update OpenAPI 3.0 Descriptions
1 parent b382274 commit fc50395

32 files changed

Lines changed: 256 additions & 432 deletions

descriptions/api.github.com/api.github.com.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25833,7 +25833,7 @@
2583325833
},
2583425834
"output": {
2583525835
"type": "object",
25836-
"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.",
25836+
"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.",
2583725837
"properties": {
2583825838
"title": {
2583925839
"type": "string",
@@ -25851,7 +25851,7 @@
2585125851
},
2585225852
"annotations": {
2585325853
"type": "array",
25854-
"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.",
25854+
"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)\".",
2585525855
"maxItems": 50,
2585625856
"items": {
2585725857
"type": "object",
@@ -25909,7 +25909,7 @@
2590925909
},
2591025910
"images": {
2591125911
"type": "array",
25912-
"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.",
25912+
"description": "Adds images to the output displayed in the GitHub pull request UI.",
2591325913
"items": {
2591425914
"type": "object",
2591525915
"properties": {
@@ -25940,7 +25940,7 @@
2594025940
},
2594125941
"actions": {
2594225942
"type": "array",
25943-
"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).\"",
25943+
"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).\"",
2594425944
"maxItems": 3,
2594525945
"items": {
2594625946
"type": "object",
@@ -26221,7 +26221,7 @@
2622126221
},
2622226222
"output": {
2622326223
"type": "object",
26224-
"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.",
26224+
"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.",
2622526225
"properties": {
2622626226
"title": {
2622726227
"type": "string",
@@ -26239,7 +26239,7 @@
2623926239
},
2624026240
"annotations": {
2624126241
"type": "array",
26242-
"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.",
26242+
"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)\".",
2624326243
"maxItems": 50,
2624426244
"items": {
2624526245
"type": "object",
@@ -26297,7 +26297,7 @@
2629726297
},
2629826298
"images": {
2629926299
"type": "array",
26300-
"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.",
26300+
"description": "Adds images to the output displayed in the GitHub pull request UI.",
2630126301
"items": {
2630226302
"type": "object",
2630326303
"properties": {
@@ -26699,7 +26699,7 @@
2669926699
"properties": {
2670026700
"auto_trigger_checks": {
2670126701
"type": "array",
26702-
"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.",
26702+
"description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.",
2670326703
"items": {
2670426704
"type": "object",
2670526705
"properties": {

descriptions/api.github.com/api.github.com.yaml

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -18569,8 +18569,7 @@ paths:
1856918569
type: object
1857018570
description: Check runs can accept a variety of data in the `output`
1857118571
object, including a `title` and `summary` and can optionally provide
18572-
descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object)
18573-
description.
18572+
descriptive details about the run.
1857418573
properties:
1857518574
title:
1857618575
type: string
@@ -18597,8 +18596,6 @@ paths:
1859718596
are appended to the list of annotations that already exist
1859818597
for the check run. For details about how you can view annotations
1859918598
on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)".
18600-
See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object)
18601-
description for details about how to use this parameter.
1860218599
maxItems: 50
1860318600
items:
1860418601
type: object
@@ -18653,8 +18650,7 @@ paths:
1865318650
images:
1865418651
type: array
1865518652
description: Adds images to the output displayed in the GitHub
18656-
pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#images-object)
18657-
description for details.
18653+
pull request UI.
1865818654
items:
1865918655
type: object
1866018656
properties:
@@ -18682,10 +18678,9 @@ paths:
1868218678
run completes. When a user clicks the button, GitHub sends the
1868318679
[`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run)
1868418680
to your app. Each action includes a `label`, `identifier` and
18685-
`description`. A maximum of three actions are accepted. See the
18686-
[`actions` object](https://docs.github.com/rest/reference/checks#actions-object)
18687-
description. To learn more about check runs and requested actions,
18688-
see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)."
18681+
`description`. A maximum of three actions are accepted. To learn
18682+
more about check runs and requested actions, see "[Check runs
18683+
and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)."
1868918684
maxItems: 3
1869018685
items:
1869118686
type: object
@@ -18897,8 +18892,7 @@ paths:
1889718892
type: object
1889818893
description: Check runs can accept a variety of data in the `output`
1889918894
object, including a `title` and `summary` and can optionally provide
18900-
descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object-1)
18901-
description.
18895+
descriptive details about the run.
1890218896
properties:
1890318897
title:
1890418898
type: string
@@ -18923,8 +18917,6 @@ paths:
1892318917
are appended to the list of annotations that already exist
1892418918
for the check run. For details about annotations in the UI,
1892518919
see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)".
18926-
See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1)
18927-
description for details.
1892818920
maxItems: 50
1892918921
items:
1893018922
type: object
@@ -18979,8 +18971,7 @@ paths:
1897918971
images:
1898018972
type: array
1898118973
description: Adds images to the output displayed in the GitHub
18982-
pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1)
18983-
description for details.
18974+
pull request UI.
1898418975
items:
1898518976
type: object
1898618977
properties:
@@ -19260,9 +19251,7 @@ paths:
1926019251
auto_trigger_checks:
1926119252
type: array
1926219253
description: Enables or disables automatic creation of CheckSuite
19263-
events upon pushes to the repository. Enabled by default. See
19264-
the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object)
19265-
description for details.
19254+
events upon pushes to the repository. Enabled by default.
1926619255
items:
1926719256
type: object
1926819257
properties:

0 commit comments

Comments
 (0)