Skip to content

Update OpenAPI 3.1 Descriptions #1655

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
ahoglund merged 1 commit into from
Oct 10, 2022
Merged

Update OpenAPI 3.1 Descriptions #1655

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
46 changes: 45 additions & 1 deletion 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 @@ -12007,6 +12007,14 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/interaction-limit"
},
"examples": {
"default": {
"value": {
"limit": "collaborators_only",
"expiry": "one_month"
}
}
}
}
}
Expand Down Expand Up @@ -33071,6 +33079,15 @@
"description": "When forking from an existing repository, fork with only the default branch."
}
}
},
"examples": {
"default": {
"value": {
"organization": "octocat",
"name": "Hello-World",
"default_branch_only": true
}
}
}
}
}
Expand Down Expand Up @@ -42304,14 +42321,22 @@
},
"merge_method": {
"type": "string",
"description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.",
"description": "The merge method to use.",
"enum": [
"merge",
"squash",
"rebase"
]
}
}
},
"examples": {
"response-if-merge-was-successful": {
"value": {
"commit_title": "Expand enum",
"commit_message": "Add a new value to the merge_method enum"
}
}
}
}
}
Expand Down Expand Up @@ -45522,6 +45547,14 @@
"description": "Determines if all notifications should be blocked from this repository."
}
}
},
"examples": {
"default": {
"value": {
"subscribed": true,
"ignored": false
}
}
}
}
}
Expand Down Expand Up @@ -54642,6 +54675,17 @@
"name"
],
"type": "object"
},
"examples": {
"default": {
"value": {
"name": "Hello-World",
"description": "This is your first repo!",
"homepage": "https://github.com",
"private": false,
"is_template": true
}
}
}
}
}
Expand Down
32 changes: 30 additions & 2 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 @@ -8737,6 +8737,11 @@ paths:
application/json:
schema:
"$ref": "#/components/schemas/interaction-limit"
examples:
default:
value:
limit: collaborators_only
expiry: one_month
responses:
'200':
description: Response
Expand Down Expand Up @@ -24070,6 +24075,12 @@ paths:
type: boolean
description: When forking from an existing repository, fork with
only the default branch.
examples:
default:
value:
organization: octocat
name: Hello-World
default_branch_only: true
responses:
'202':
description: Response
Expand Down Expand Up @@ -30478,12 +30489,16 @@ paths:
description: SHA that pull request head must match to allow merge.
merge_method:
type: string
description: Merge method to use. Possible values are `merge`, `squash`
or `rebase`. Default is `merge`.
description: The merge method to use.
enum:
- merge
- squash
- rebase
examples:
response-if-merge-was-successful:
value:
commit_title: Expand enum
commit_message: Add a new value to the merge_method enum
responses:
'200':
description: if merge was successful
Expand Down Expand Up @@ -32677,6 +32692,11 @@ paths:
type: boolean
description: Determines if all notifications should be blocked from
this repository.
examples:
default:
value:
subscribed: true
ignored: false
responses:
'200':
description: Response
Expand Down Expand Up @@ -39428,6 +39448,14 @@ paths:
required:
- name
type: object
examples:
default:
value:
name: Hello-World
description: This is your first repo!
homepage: https://github.com
private: false
is_template: true
responses:
'201':
description: Response
Expand Down
46 changes: 45 additions & 1 deletion descriptions-next/api.github.com/dereferenced/api.github.com.deref.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86436,6 +86436,14 @@
"required": [
"limit"
]
},
"examples": {
"default": {
"value": {
"limit": "collaborators_only",
"expiry": "one_month"
}
}
}
}
}
Expand Down Expand Up @@ -260806,6 +260814,15 @@
"description": "When forking from an existing repository, fork with only the default branch."
}
}
},
"examples": {
"default": {
"value": {
"organization": "octocat",
"name": "Hello-World",
"default_branch_only": true
}
}
}
}
}
Expand Down Expand Up @@ -382646,14 +382663,22 @@
},
"merge_method": {
"type": "string",
"description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.",
"description": "The merge method to use.",
"enum": [
"merge",
"squash",
"rebase"
]
}
}
},
"examples": {
"response-if-merge-was-successful": {
"value": {
"commit_title": "Expand enum",
"commit_message": "Add a new value to the merge_method enum"
}
}
}
}
}
Expand Down Expand Up @@ -411487,6 +411512,14 @@
"description": "Determines if all notifications should be blocked from this repository."
}
}
},
"examples": {
"default": {
"value": {
"subscribed": true,
"ignored": false
}
}
}
}
}
Expand Down Expand Up @@ -484971,6 +485004,17 @@
"name"
],
"type": "object"
},
"examples": {
"default": {
"value": {
"name": "Hello-World",
"description": "This is your first repo!",
"homepage": "https://github.com",
"private": false,
"is_template": true
}
}
}
}
}
Expand Down
32 changes: 30 additions & 2 deletions descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21035,6 +21035,11 @@ paths:
- one_month
required:
- limit
examples:
default:
value:
limit: collaborators_only
expiry: one_month
responses:
'200':
description: Response
Expand Down Expand Up @@ -52203,6 +52208,12 @@ paths:
type: boolean
description: When forking from an existing repository, fork with
only the default branch.
examples:
default:
value:
organization: octocat
name: Hello-World
default_branch_only: true
responses:
'202':
description: Response
Expand Down Expand Up @@ -64719,12 +64730,16 @@ paths:
description: SHA that pull request head must match to allow merge.
merge_method:
type: string
description: Merge method to use. Possible values are `merge`, `squash`
or `rebase`. Default is `merge`.
description: The merge method to use.
enum:
- merge
- squash
- rebase
examples:
response-if-merge-was-successful:
value:
commit_title: Expand enum
commit_message: Add a new value to the merge_method enum
responses:
'200':
description: if merge was successful
Expand Down Expand Up @@ -69393,6 +69408,11 @@ paths:
type: boolean
description: Determines if all notifications should be blocked from
this repository.
examples:
default:
value:
subscribed: true
ignored: false
responses:
'200':
description: Response
Expand Down Expand Up @@ -80010,6 +80030,14 @@ paths:
required:
- name
type: object
examples:
default:
value:
name: Hello-World
description: This is your first repo!
homepage: https://github.com
private: false
is_template: true
responses:
'201':
description: Response
Expand Down
Loading