Skip to content

Commit aa0fc7a

Browse files
ahoglundahoglund
authored
Merge pull request #1654 from github/openapi-update-d3f696778925e7468cf22a56c532b18576042403be54138157225e6fb5109ae4
Update OpenAPI 3.0 Descriptions
2 parents db3cdf9 + c7ec48a commit aa0fc7a

32 files changed

Lines changed: 9319 additions & 3811 deletions

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

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11951,6 +11951,14 @@
1195111951
"application/json": {
1195211952
"schema": {
1195311953
"$ref": "#/components/schemas/interaction-limit"
11954+
},
11955+
"examples": {
11956+
"default": {
11957+
"value": {
11958+
"limit": "collaborators_only",
11959+
"expiry": "one_month"
11960+
}
11961+
}
1195411962
}
1195511963
}
1195611964
}
@@ -32903,6 +32911,15 @@
3290332911
"description": "When forking from an existing repository, fork with only the default branch."
3290432912
}
3290532913
}
32914+
},
32915+
"examples": {
32916+
"default": {
32917+
"value": {
32918+
"organization": "octocat",
32919+
"name": "Hello-World",
32920+
"default_branch_only": true
32921+
}
32922+
}
3290632923
}
3290732924
}
3290832925
}
@@ -42071,14 +42088,22 @@
4207142088
},
4207242089
"merge_method": {
4207342090
"type": "string",
42074-
"description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.",
42091+
"description": "The merge method to use.",
4207542092
"enum": [
4207642093
"merge",
4207742094
"squash",
4207842095
"rebase"
4207942096
]
4208042097
}
4208142098
}
42099+
},
42100+
"examples": {
42101+
"response-if-merge-was-successful": {
42102+
"value": {
42103+
"commit_title": "Expand enum",
42104+
"commit_message": "Add a new value to the merge_method enum"
42105+
}
42106+
}
4208242107
}
4208342108
}
4208442109
}
@@ -45271,6 +45296,14 @@
4527145296
"description": "Determines if all notifications should be blocked from this repository."
4527245297
}
4527345298
}
45299+
},
45300+
"examples": {
45301+
"default": {
45302+
"value": {
45303+
"subscribed": true,
45304+
"ignored": false
45305+
}
45306+
}
4527445307
}
4527545308
}
4527645309
}
@@ -54315,6 +54348,17 @@
5431554348
"name"
5431654349
],
5431754350
"type": "object"
54351+
},
54352+
"examples": {
54353+
"default": {
54354+
"value": {
54355+
"name": "Hello-World",
54356+
"description": "This is your first repo!",
54357+
"homepage": "https://github.com",
54358+
"private": false,
54359+
"is_template": true
54360+
}
54361+
}
5431854362
}
5431954363
}
5432054364
}

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

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8711,6 +8711,11 @@ paths:
87118711
application/json:
87128712
schema:
87138713
"$ref": "#/components/schemas/interaction-limit"
8714+
examples:
8715+
default:
8716+
value:
8717+
limit: collaborators_only
8718+
expiry: one_month
87148719
responses:
87158720
'200':
87168721
description: Response
@@ -23989,6 +23994,12 @@ paths:
2398923994
type: boolean
2399023995
description: When forking from an existing repository, fork with
2399123996
only the default branch.
23997+
examples:
23998+
default:
23999+
value:
24000+
organization: octocat
24001+
name: Hello-World
24002+
default_branch_only: true
2399224003
responses:
2399324004
'202':
2399424005
description: Response
@@ -30361,12 +30372,16 @@ paths:
3036130372
description: SHA that pull request head must match to allow merge.
3036230373
merge_method:
3036330374
type: string
30364-
description: Merge method to use. Possible values are `merge`, `squash`
30365-
or `rebase`. Default is `merge`.
30375+
description: The merge method to use.
3036630376
enum:
3036730377
- merge
3036830378
- squash
3036930379
- rebase
30380+
examples:
30381+
response-if-merge-was-successful:
30382+
value:
30383+
commit_title: Expand enum
30384+
commit_message: Add a new value to the merge_method enum
3037030385
responses:
3037130386
'200':
3037230387
description: if merge was successful
@@ -32551,6 +32566,11 @@ paths:
3255132566
type: boolean
3255232567
description: Determines if all notifications should be blocked from
3255332568
this repository.
32569+
examples:
32570+
default:
32571+
value:
32572+
subscribed: true
32573+
ignored: false
3255432574
responses:
3255532575
'200':
3255632576
description: Response
@@ -39265,6 +39285,14 @@ paths:
3926539285
required:
3926639286
- name
3926739287
type: object
39288+
examples:
39289+
default:
39290+
value:
39291+
name: Hello-World
39292+
description: This is your first repo!
39293+
homepage: https://github.com
39294+
private: false
39295+
is_template: true
3926839296
responses:
3926939297
'201':
3927039298
description: Response

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

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74723,6 +74723,14 @@
7472374723
"required": [
7472474724
"limit"
7472574725
]
74726+
},
74727+
"examples": {
74728+
"default": {
74729+
"value": {
74730+
"limit": "collaborators_only",
74731+
"expiry": "one_month"
74732+
}
74733+
}
7472674734
}
7472774735
}
7472874736
}
@@ -222247,6 +222255,15 @@
222247222255
"description": "When forking from an existing repository, fork with only the default branch."
222248222256
}
222249222257
}
222258+
},
222259+
"examples": {
222260+
"default": {
222261+
"value": {
222262+
"organization": "octocat",
222263+
"name": "Hello-World",
222264+
"default_branch_only": true
222265+
}
222266+
}
222250222267
}
222251222268
}
222252222269
}
@@ -322681,14 +322698,22 @@
322681322698
},
322682322699
"merge_method": {
322683322700
"type": "string",
322684-
"description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.",
322701+
"description": "The merge method to use.",
322685322702
"enum": [
322686322703
"merge",
322687322704
"squash",
322688322705
"rebase"
322689322706
]
322690322707
}
322691322708
}
322709+
},
322710+
"examples": {
322711+
"response-if-merge-was-successful": {
322712+
"value": {
322713+
"commit_title": "Expand enum",
322714+
"commit_message": "Add a new value to the merge_method enum"
322715+
}
322716+
}
322692322717
}
322693322718
}
322694322719
}
@@ -347083,6 +347108,14 @@
347083347108
"description": "Determines if all notifications should be blocked from this repository."
347084347109
}
347085347110
}
347111+
},
347112+
"examples": {
347113+
"default": {
347114+
"value": {
347115+
"subscribed": true,
347116+
"ignored": false
347117+
}
347118+
}
347086347119
}
347087347120
}
347088347121
}
@@ -409665,6 +409698,17 @@
409665409698
"name"
409666409699
],
409667409700
"type": "object"
409701+
},
409702+
"examples": {
409703+
"default": {
409704+
"value": {
409705+
"name": "Hello-World",
409706+
"description": "This is your first repo!",
409707+
"homepage": "https://github.com",
409708+
"private": false,
409709+
"is_template": true
409710+
}
409711+
}
409668409712
}
409669409713
}
409670409714
}

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

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20438,6 +20438,11 @@ paths:
2043820438
- six_months
2043920439
required:
2044020440
- limit
20441+
examples:
20442+
default:
20443+
value:
20444+
limit: collaborators_only
20445+
expiry: one_month
2044120446
responses:
2044220447
'200':
2044320448
description: Response
@@ -50864,6 +50869,12 @@ paths:
5086450869
type: boolean
5086550870
description: When forking from an existing repository, fork with
5086650871
only the default branch.
50872+
examples:
50873+
default:
50874+
value:
50875+
organization: octocat
50876+
name: Hello-World
50877+
default_branch_only: true
5086750878
responses:
5086850879
'202':
5086950880
description: Response
@@ -63218,12 +63229,16 @@ paths:
6321863229
description: SHA that pull request head must match to allow merge.
6321963230
merge_method:
6322063231
type: string
63221-
description: Merge method to use. Possible values are `merge`, `squash`
63222-
or `rebase`. Default is `merge`.
63232+
description: The merge method to use.
6322363233
enum:
6322463234
- merge
6322563235
- squash
6322663236
- rebase
63237+
examples:
63238+
response-if-merge-was-successful:
63239+
value:
63240+
commit_title: Expand enum
63241+
commit_message: Add a new value to the merge_method enum
6322763242
responses:
6322863243
'200':
6322963244
description: if merge was successful
@@ -67842,6 +67857,11 @@ paths:
6784267857
type: boolean
6784367858
description: Determines if all notifications should be blocked from
6784467859
this repository.
67860+
examples:
67861+
default:
67862+
value:
67863+
subscribed: true
67864+
ignored: false
6784567865
responses:
6784667866
'200':
6784767867
description: Response
@@ -78305,6 +78325,14 @@ paths:
7830578325
required:
7830678326
- name
7830778327
type: object
78328+
examples:
78329+
default:
78330+
value:
78331+
name: Hello-World
78332+
description: This is your first repo!
78333+
homepage: https://github.com
78334+
private: false
78335+
is_template: true
7830878336
responses:
7830978337
'201':
7831078338
description: Response

0 commit comments

Comments
 (0)