Skip to content

Commit a81864b

Browse files
ahoglundahoglund
authored
Merge pull request #1655 from github/openapi-update-260571349552a8e357b0c19007a969373f5006a51d1719512294fe7b7b509abd
Update OpenAPI 3.1 Descriptions
2 parents aa0fc7a + 8bac728 commit a81864b

32 files changed

Lines changed: 10199 additions & 3655 deletions

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

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12007,6 +12007,14 @@
1200712007
"application/json": {
1200812008
"schema": {
1200912009
"$ref": "#/components/schemas/interaction-limit"
12010+
},
12011+
"examples": {
12012+
"default": {
12013+
"value": {
12014+
"limit": "collaborators_only",
12015+
"expiry": "one_month"
12016+
}
12017+
}
1201012018
}
1201112019
}
1201212020
}
@@ -33071,6 +33079,15 @@
3307133079
"description": "When forking from an existing repository, fork with only the default branch."
3307233080
}
3307333081
}
33082+
},
33083+
"examples": {
33084+
"default": {
33085+
"value": {
33086+
"organization": "octocat",
33087+
"name": "Hello-World",
33088+
"default_branch_only": true
33089+
}
33090+
}
3307433091
}
3307533092
}
3307633093
}
@@ -42304,14 +42321,22 @@
4230442321
},
4230542322
"merge_method": {
4230642323
"type": "string",
42307-
"description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.",
42324+
"description": "The merge method to use.",
4230842325
"enum": [
4230942326
"merge",
4231042327
"squash",
4231142328
"rebase"
4231242329
]
4231342330
}
4231442331
}
42332+
},
42333+
"examples": {
42334+
"response-if-merge-was-successful": {
42335+
"value": {
42336+
"commit_title": "Expand enum",
42337+
"commit_message": "Add a new value to the merge_method enum"
42338+
}
42339+
}
4231542340
}
4231642341
}
4231742342
}
@@ -45522,6 +45547,14 @@
4552245547
"description": "Determines if all notifications should be blocked from this repository."
4552345548
}
4552445549
}
45550+
},
45551+
"examples": {
45552+
"default": {
45553+
"value": {
45554+
"subscribed": true,
45555+
"ignored": false
45556+
}
45557+
}
4552545558
}
4552645559
}
4552745560
}
@@ -54642,6 +54675,17 @@
5464254675
"name"
5464354676
],
5464454677
"type": "object"
54678+
},
54679+
"examples": {
54680+
"default": {
54681+
"value": {
54682+
"name": "Hello-World",
54683+
"description": "This is your first repo!",
54684+
"homepage": "https://github.com",
54685+
"private": false,
54686+
"is_template": true
54687+
}
54688+
}
5464554689
}
5464654690
}
5464754691
}

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

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8737,6 +8737,11 @@ paths:
87378737
application/json:
87388738
schema:
87398739
"$ref": "#/components/schemas/interaction-limit"
8740+
examples:
8741+
default:
8742+
value:
8743+
limit: collaborators_only
8744+
expiry: one_month
87408745
responses:
87418746
'200':
87428747
description: Response
@@ -24070,6 +24075,12 @@ paths:
2407024075
type: boolean
2407124076
description: When forking from an existing repository, fork with
2407224077
only the default branch.
24078+
examples:
24079+
default:
24080+
value:
24081+
organization: octocat
24082+
name: Hello-World
24083+
default_branch_only: true
2407324084
responses:
2407424085
'202':
2407524086
description: Response
@@ -30478,12 +30489,16 @@ paths:
3047830489
description: SHA that pull request head must match to allow merge.
3047930490
merge_method:
3048030491
type: string
30481-
description: Merge method to use. Possible values are `merge`, `squash`
30482-
or `rebase`. Default is `merge`.
30492+
description: The merge method to use.
3048330493
enum:
3048430494
- merge
3048530495
- squash
3048630496
- rebase
30497+
examples:
30498+
response-if-merge-was-successful:
30499+
value:
30500+
commit_title: Expand enum
30501+
commit_message: Add a new value to the merge_method enum
3048730502
responses:
3048830503
'200':
3048930504
description: if merge was successful
@@ -32677,6 +32692,11 @@ paths:
3267732692
type: boolean
3267832693
description: Determines if all notifications should be blocked from
3267932694
this repository.
32695+
examples:
32696+
default:
32697+
value:
32698+
subscribed: true
32699+
ignored: false
3268032700
responses:
3268132701
'200':
3268232702
description: Response
@@ -39428,6 +39448,14 @@ paths:
3942839448
required:
3942939449
- name
3943039450
type: object
39451+
examples:
39452+
default:
39453+
value:
39454+
name: Hello-World
39455+
description: This is your first repo!
39456+
homepage: https://github.com
39457+
private: false
39458+
is_template: true
3943139459
responses:
3943239460
'201':
3943339461
description: Response

‎descriptions-next/api.github.com/dereferenced/api.github.com.deref.json‎

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86436,6 +86436,14 @@
8643686436
"required": [
8643786437
"limit"
8643886438
]
86439+
},
86440+
"examples": {
86441+
"default": {
86442+
"value": {
86443+
"limit": "collaborators_only",
86444+
"expiry": "one_month"
86445+
}
86446+
}
8643986447
}
8644086448
}
8644186449
}
@@ -260806,6 +260814,15 @@
260806260814
"description": "When forking from an existing repository, fork with only the default branch."
260807260815
}
260808260816
}
260817+
},
260818+
"examples": {
260819+
"default": {
260820+
"value": {
260821+
"organization": "octocat",
260822+
"name": "Hello-World",
260823+
"default_branch_only": true
260824+
}
260825+
}
260809260826
}
260810260827
}
260811260828
}
@@ -382646,14 +382663,22 @@
382646382663
},
382647382664
"merge_method": {
382648382665
"type": "string",
382649-
"description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.",
382666+
"description": "The merge method to use.",
382650382667
"enum": [
382651382668
"merge",
382652382669
"squash",
382653382670
"rebase"
382654382671
]
382655382672
}
382656382673
}
382674+
},
382675+
"examples": {
382676+
"response-if-merge-was-successful": {
382677+
"value": {
382678+
"commit_title": "Expand enum",
382679+
"commit_message": "Add a new value to the merge_method enum"
382680+
}
382681+
}
382657382682
}
382658382683
}
382659382684
}
@@ -411487,6 +411512,14 @@
411487411512
"description": "Determines if all notifications should be blocked from this repository."
411488411513
}
411489411514
}
411515+
},
411516+
"examples": {
411517+
"default": {
411518+
"value": {
411519+
"subscribed": true,
411520+
"ignored": false
411521+
}
411522+
}
411490411523
}
411491411524
}
411492411525
}
@@ -484971,6 +485004,17 @@
484971485004
"name"
484972485005
],
484973485006
"type": "object"
485007+
},
485008+
"examples": {
485009+
"default": {
485010+
"value": {
485011+
"name": "Hello-World",
485012+
"description": "This is your first repo!",
485013+
"homepage": "https://github.com",
485014+
"private": false,
485015+
"is_template": true
485016+
}
485017+
}
484974485018
}
484975485019
}
484976485020
}

‎descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml‎

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21035,6 +21035,11 @@ paths:
2103521035
- one_month
2103621036
required:
2103721037
- limit
21038+
examples:
21039+
default:
21040+
value:
21041+
limit: collaborators_only
21042+
expiry: one_month
2103821043
responses:
2103921044
'200':
2104021045
description: Response
@@ -52203,6 +52208,12 @@ paths:
5220352208
type: boolean
5220452209
description: When forking from an existing repository, fork with
5220552210
only the default branch.
52211+
examples:
52212+
default:
52213+
value:
52214+
organization: octocat
52215+
name: Hello-World
52216+
default_branch_only: true
5220652217
responses:
5220752218
'202':
5220852219
description: Response
@@ -64719,12 +64730,16 @@ paths:
6471964730
description: SHA that pull request head must match to allow merge.
6472064731
merge_method:
6472164732
type: string
64722-
description: Merge method to use. Possible values are `merge`, `squash`
64723-
or `rebase`. Default is `merge`.
64733+
description: The merge method to use.
6472464734
enum:
6472564735
- merge
6472664736
- squash
6472764737
- rebase
64738+
examples:
64739+
response-if-merge-was-successful:
64740+
value:
64741+
commit_title: Expand enum
64742+
commit_message: Add a new value to the merge_method enum
6472864743
responses:
6472964744
'200':
6473064745
description: if merge was successful
@@ -69393,6 +69408,11 @@ paths:
6939369408
type: boolean
6939469409
description: Determines if all notifications should be blocked from
6939569410
this repository.
69411+
examples:
69412+
default:
69413+
value:
69414+
subscribed: true
69415+
ignored: false
6939669416
responses:
6939769417
'200':
6939869418
description: Response
@@ -80010,6 +80030,14 @@ paths:
8001080030
required:
8001180031
- name
8001280032
type: object
80033+
examples:
80034+
default:
80035+
value:
80036+
name: Hello-World
80037+
description: This is your first repo!
80038+
homepage: https://github.com
80039+
private: false
80040+
is_template: true
8001380041
responses:
8001480042
'201':
8001580043
description: Response

0 commit comments

Comments
 (0)