Skip to content

Commit ea6d0e9

Browse files
authored
Merge pull request #1663 from github/openapi-update-525d4eeec5d582d0c3449b087da8866af90d58d23869246ec013de988fefe4e1
Update OpenAPI 3.1 Descriptions
2 parents 0dfdef6 + 74b644a commit ea6d0e9

32 files changed

Lines changed: 256 additions & 432 deletions

descriptions-next/api.github.com/api.github.com.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25967,7 +25967,7 @@
2596725967
},
2596825968
"output": {
2596925969
"type": "object",
25970-
"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.",
25970+
"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.",
2597125971
"properties": {
2597225972
"title": {
2597325973
"type": "string",
@@ -25985,7 +25985,7 @@
2598525985
},
2598625986
"annotations": {
2598725987
"type": "array",
25988-
"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.",
25988+
"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)\".",
2598925989
"maxItems": 50,
2599025990
"items": {
2599125991
"type": "object",
@@ -26043,7 +26043,7 @@
2604326043
},
2604426044
"images": {
2604526045
"type": "array",
26046-
"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.",
26046+
"description": "Adds images to the output displayed in the GitHub pull request UI.",
2604726047
"items": {
2604826048
"type": "object",
2604926049
"properties": {
@@ -26074,7 +26074,7 @@
2607426074
},
2607526075
"actions": {
2607626076
"type": "array",
26077-
"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).\"",
26077+
"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).\"",
2607826078
"maxItems": 3,
2607926079
"items": {
2608026080
"type": "object",
@@ -26355,7 +26355,7 @@
2635526355
},
2635626356
"output": {
2635726357
"type": "object",
26358-
"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.",
26358+
"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.",
2635926359
"properties": {
2636026360
"title": {
2636126361
"type": "string",
@@ -26373,7 +26373,7 @@
2637326373
},
2637426374
"annotations": {
2637526375
"type": "array",
26376-
"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.",
26376+
"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)\".",
2637726377
"maxItems": 50,
2637826378
"items": {
2637926379
"type": "object",
@@ -26431,7 +26431,7 @@
2643126431
},
2643226432
"images": {
2643326433
"type": "array",
26434-
"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.",
26434+
"description": "Adds images to the output displayed in the GitHub pull request UI.",
2643526435
"items": {
2643626436
"type": "object",
2643726437
"properties": {
@@ -26833,7 +26833,7 @@
2683326833
"properties": {
2683426834
"auto_trigger_checks": {
2683526835
"type": "array",
26836-
"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.",
26836+
"description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.",
2683726837
"items": {
2683826838
"type": "object",
2683926839
"properties": {

descriptions-next/api.github.com/api.github.com.yaml

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -18633,8 +18633,7 @@ paths:
1863318633
type: object
1863418634
description: Check runs can accept a variety of data in the `output`
1863518635
object, including a `title` and `summary` and can optionally provide
18636-
descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object)
18637-
description.
18636+
descriptive details about the run.
1863818637
properties:
1863918638
title:
1864018639
type: string
@@ -18661,8 +18660,6 @@ paths:
1866118660
are appended to the list of annotations that already exist
1866218661
for the check run. For details about how you can view annotations
1866318662
on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)".
18664-
See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object)
18665-
description for details about how to use this parameter.
1866618663
maxItems: 50
1866718664
items:
1866818665
type: object
@@ -18717,8 +18714,7 @@ paths:
1871718714
images:
1871818715
type: array
1871918716
description: Adds images to the output displayed in the GitHub
18720-
pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#images-object)
18721-
description for details.
18717+
pull request UI.
1872218718
items:
1872318719
type: object
1872418720
properties:
@@ -18746,10 +18742,9 @@ paths:
1874618742
run completes. When a user clicks the button, GitHub sends the
1874718743
[`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run)
1874818744
to your app. Each action includes a `label`, `identifier` and
18749-
`description`. A maximum of three actions are accepted. See the
18750-
[`actions` object](https://docs.github.com/rest/reference/checks#actions-object)
18751-
description. To learn more about check runs and requested actions,
18752-
see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)."
18745+
`description`. A maximum of three actions are accepted. To learn
18746+
more about check runs and requested actions, see "[Check runs
18747+
and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)."
1875318748
maxItems: 3
1875418749
items:
1875518750
type: object
@@ -18961,8 +18956,7 @@ paths:
1896118956
type: object
1896218957
description: Check runs can accept a variety of data in the `output`
1896318958
object, including a `title` and `summary` and can optionally provide
18964-
descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object-1)
18965-
description.
18959+
descriptive details about the run.
1896618960
properties:
1896718961
title:
1896818962
type: string
@@ -18987,8 +18981,6 @@ paths:
1898718981
are appended to the list of annotations that already exist
1898818982
for the check run. For details about annotations in the UI,
1898918983
see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)".
18990-
See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1)
18991-
description for details.
1899218984
maxItems: 50
1899318985
items:
1899418986
type: object
@@ -19043,8 +19035,7 @@ paths:
1904319035
images:
1904419036
type: array
1904519037
description: Adds images to the output displayed in the GitHub
19046-
pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1)
19047-
description for details.
19038+
pull request UI.
1904819039
items:
1904919040
type: object
1905019041
properties:
@@ -19324,9 +19315,7 @@ paths:
1932419315
auto_trigger_checks:
1932519316
type: array
1932619317
description: Enables or disables automatic creation of CheckSuite
19327-
events upon pushes to the repository. Enabled by default. See
19328-
the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object)
19329-
description for details.
19318+
events upon pushes to the repository. Enabled by default.
1933019319
items:
1933119320
type: object
1933219321
properties:

0 commit comments

Comments
 (0)