Skip to content

Update OpenAPI 3.1 Descriptions #1663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bearcherian merged 1 commit into from
Oct 12, 2022
Merged

Update OpenAPI 3.1 Descriptions #1663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions descriptions-next/api.github.com/api.github.com.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down
27 changes: 8 additions & 19 deletions descriptions-next/api.github.com/api.github.com.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
Loading