Skip to content

Update OpenAPI 3.1 Descriptions #1472

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
becco merged 1 commit into from
Aug 18, 2022
Merged

Update OpenAPI 3.1 Descriptions #1472

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
272 changes: 260 additions & 12 deletions descriptions-next/api.github.com/api.github.com.json
View file
Open in desktop

Large diffs are not rendered by default.

309 changes: 300 additions & 9 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 @@ -10229,6 +10229,50 @@ paths:
description: Either `true` to allow squash-merge commits to use
pull request title, or `false` to use commit message.
default: false
squash_merge_commit_title:
type: string
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: |-
The default value for a squash merge commit title:

- `PR_TITLE` - default to the pull request's title.
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
squash_merge_commit_message:
type: string
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: |-
The default value for a squash merge commit message:

- `PR_BODY` - default to the pull request's body.
- `COMMIT_MESSAGES` - default to the branch's commit messages.
- `BLANK` - default to a blank commit message.
merge_commit_title:
type: string
enum:
- PR_TITLE
- MERGE_MESSAGE
description: |-
The default value for a merge commit title.

- `PR_TITLE` - default to the pull request's title.
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
merge_commit_message:
type: string
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: |-
The default value for a merge commit message.

- `PR_TITLE` - default to the pull request's title.
- `PR_BODY` - default to the pull request's body.
- `BLANK` - default to a blank commit message.
required:
- name
examples:
Expand Down Expand Up @@ -13591,6 +13635,50 @@ paths:
description: Either `true` to allow squash-merge commits to use
pull request title, or `false` to use commit message.
default: false
squash_merge_commit_title:
type: string
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: |-
The default value for a squash merge commit title:

- `PR_TITLE` - default to the pull request's title.
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
squash_merge_commit_message:
type: string
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: |-
The default value for a squash merge commit message:

- `PR_BODY` - default to the pull request's body.
- `COMMIT_MESSAGES` - default to the branch's commit messages.
- `BLANK` - default to a blank commit message.
merge_commit_title:
type: string
enum:
- PR_TITLE
- MERGE_MESSAGE
description: |-
The default value for a merge commit title.

- `PR_TITLE` - default to the pull request's title.
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
merge_commit_message:
type: string
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: |-
The default value for a merge commit message.

- `PR_TITLE` - default to the pull request's title.
- `PR_BODY` - default to the pull request's body.
- `BLANK` - default to a blank commit message.
archived:
type: boolean
description: "`true` to archive this repository. **Note**: You cannot
Expand Down Expand Up @@ -14042,6 +14130,9 @@ paths:
type: boolean
default: false
description: Whether to enable debug logging for the re-run.
examples:
default:
value:
responses:
'201':
description: Response
Expand Down Expand Up @@ -15181,9 +15272,10 @@ paths:
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
"$ref": "#/components/schemas/empty-object"
examples:
default:
value:
'409':
"$ref": "#/components/responses/conflict"
x-github:
Expand Down Expand Up @@ -15394,6 +15486,13 @@ paths:
- environment_ids
- state
- comment
examples:
default:
value:
environment_ids:
- 161171787
state: approved
comment: Ship it!
responses:
'200':
description: Response
Expand Down Expand Up @@ -15440,15 +15539,19 @@ paths:
type: boolean
default: false
description: Whether to enable debug logging for the re-run.
examples:
default:
value:
responses:
'201':
description: Response
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
"$ref": "#/components/schemas/empty-object"
examples:
default:
value:
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
Expand Down Expand Up @@ -15483,6 +15586,9 @@ paths:
type: boolean
default: false
description: Whether to enable debug logging for the re-run.
examples:
default:
value:
responses:
'201':
description: Response
Expand Down Expand Up @@ -15756,9 +15862,10 @@ paths:
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
"$ref": "#/components/schemas/empty-object"
examples:
default:
value:
'204':
description: Response when updating a secret
x-github:
Expand Down Expand Up @@ -40004,6 +40111,50 @@ paths:
type: boolean
examples:
- false
squash_merge_commit_title:
type: string
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: |-
The default value for a squash merge commit title:

- `PR_TITLE` - default to the pull request's title.
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
squash_merge_commit_message:
type: string
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: |-
The default value for a squash merge commit message:

- `PR_BODY` - default to the pull request's body.
- `COMMIT_MESSAGES` - default to the branch's commit messages.
- `BLANK` - default to a blank commit message.
merge_commit_title:
type: string
enum:
- PR_TITLE
- MERGE_MESSAGE
description: |-
The default value for a merge commit title.

- `PR_TITLE` - default to the pull request's title.
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
merge_commit_message:
type: string
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: |-
The default value for a merge commit message.

- `PR_TITLE` - default to the pull request's title.
- `PR_BODY` - default to the pull request's body.
- `BLANK` - default to a blank commit message.
has_downloads:
description: Whether downloads are enabled.
default: true
Expand Down Expand Up @@ -43308,6 +43459,50 @@ components:
type: boolean
use_squash_pr_title_as_default:
type: boolean
squash_merge_commit_title:
type: string
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: |-
The default value for a squash merge commit title:

- `PR_TITLE` - default to the pull request's title.
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
squash_merge_commit_message:
type: string
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: |-
The default value for a squash merge commit message:

- `PR_BODY` - default to the pull request's body.
- `COMMIT_MESSAGES` - default to the branch's commit messages.
- `BLANK` - default to a blank commit message.
merge_commit_title:
type: string
enum:
- PR_TITLE
- MERGE_MESSAGE
description: |-
The default value for a merge commit title.

- `PR_TITLE` - default to the pull request's title.
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
merge_commit_message:
type: string
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: |-
The default value for a merge commit message.

- `PR_TITLE` - default to the pull request's title.
- `PR_BODY` - default to the pull request's body.
- `BLANK` - default to a blank commit message.
allow_merge_commit:
type: boolean
subscribers_count:
Expand Down Expand Up @@ -43347,6 +43542,50 @@ components:
description: Whether a squash merge commit can use the pull request title
as default.
default: false
squash_merge_commit_title:
type: string
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: |-
The default value for a squash merge commit title:

- `PR_TITLE` - default to the pull request's title.
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
squash_merge_commit_message:
type: string
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: |-
The default value for a squash merge commit message:

- `PR_BODY` - default to the pull request's body.
- `COMMIT_MESSAGES` - default to the branch's commit messages.
- `BLANK` - default to a blank commit message.
merge_commit_title:
type: string
enum:
- PR_TITLE
- MERGE_MESSAGE
description: |-
The default value for a merge commit title.

- `PR_TITLE` - default to the pull request's title.
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
merge_commit_message:
type: string
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: |-
The default value for a merge commit message.

- `PR_TITLE` - default to the pull request's title.
- `PR_BODY` - default to the pull request's body.
- `BLANK` - default to a blank commit message.
allow_merge_commit:
description: Whether to allow merge commits for pull requests.
default: true
Expand Down Expand Up @@ -50538,6 +50777,58 @@ components:
type: boolean
examples:
- false
squash_merge_commit_title:
type: string
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: |-
The default value for a squash merge commit title:

- `PR_TITLE` - default to the pull request's title.
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
examples:
- PR_TITLE
squash_merge_commit_message:
type: string
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: |-
The default value for a squash merge commit message:

- `PR_BODY` - default to the pull request's body.
- `COMMIT_MESSAGES` - default to the branch's commit messages.
- `BLANK` - default to a blank commit message.
examples:
- PR_BODY
merge_commit_title:
type: string
enum:
- PR_TITLE
- MERGE_MESSAGE
description: |-
The default value for a merge commit title.

- `PR_TITLE` - default to the pull request's title.
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
examples:
- PR_TITLE
merge_commit_message:
type: string
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: |-
The default value for a merge commit message.

- `PR_TITLE` - default to the pull request's title.
- `PR_BODY` - default to the pull request's body.
- `BLANK` - default to a blank commit message.
examples:
- PR_BODY
allow_forking:
type: boolean
examples:
Expand Down
Loading