Skip to content

Commit 99f8351

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #1700 from github/openapi-update-8f1839915cdb97df269360f47f24b5ae5e1a5765214737ca1db30c460db0ca90
Update OpenAPI 3.1 Descriptions
2 parents 0feaa67 + a97dc7e commit 99f8351

32 files changed

Lines changed: 2257 additions & 393 deletions

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

Lines changed: 94 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -25059,6 +25059,15 @@
2505925059
}
2506025060
}
2506125061
]
25062+
},
25063+
"examples": {
25064+
"default": {
25065+
"value": {
25066+
"apps": [
25067+
"octoapp"
25068+
]
25069+
}
25070+
}
2506225071
}
2506325072
}
2506425073
}
@@ -25149,6 +25158,15 @@
2514925158
}
2515025159
}
2515125160
]
25161+
},
25162+
"examples": {
25163+
"default": {
25164+
"value": {
25165+
"apps": [
25166+
"octoapp"
25167+
]
25168+
}
25169+
}
2515225170
}
2515325171
}
2515425172
}
@@ -25238,6 +25256,15 @@
2523825256
}
2523925257
}
2524025258
]
25259+
},
25260+
"examples": {
25261+
"default": {
25262+
"value": {
25263+
"apps": [
25264+
"my-app"
25265+
]
25266+
}
25267+
}
2524125268
}
2524225269
}
2524325270
}
@@ -26856,10 +26883,12 @@
2685626883
"content": {
2685726884
"application/json": {
2685826885
"schema": {
26859-
"type": "object",
26860-
"properties": {
26861-
},
26862-
"additionalProperties": false
26886+
"$ref": "#/components/schemas/empty-object"
26887+
},
26888+
"examples": {
26889+
"default": {
26890+
"value": null
26891+
}
2686326892
}
2686426893
}
2686526894
}
@@ -27244,10 +27273,12 @@
2724427273
"content": {
2724527274
"application/json": {
2724627275
"schema": {
27247-
"type": "object",
27248-
"properties": {
27249-
},
27250-
"additionalProperties": false
27276+
"$ref": "#/components/schemas/empty-object"
27277+
},
27278+
"examples": {
27279+
"default": {
27280+
"value": null
27281+
}
2725127282
}
2725227283
}
2725327284
}
@@ -28910,10 +28941,12 @@
2891028941
"content": {
2891128942
"application/json": {
2891228943
"schema": {
28913-
"type": "object",
28914-
"properties": {
28915-
},
28916-
"additionalProperties": false
28944+
"$ref": "#/components/schemas/empty-object"
28945+
},
28946+
"examples": {
28947+
"default": {
28948+
"value": null
28949+
}
2891728950
}
2891828951
}
2891928952
}
@@ -34942,12 +34975,15 @@
3494234975
"insecure_ssl": {
3494334976
"$ref": "#/components/schemas/webhook-config-insecure-ssl"
3494434977
}
34945-
},
34946-
"example": {
34947-
"content_type": "json",
34948-
"insecure_ssl": "0",
34949-
"secret": "********",
34950-
"url": "https://example.com/webhook"
34978+
}
34979+
},
34980+
"examples": {
34981+
"default": {
34982+
"summary": "Example of updating content type and URL",
34983+
"value": {
34984+
"content_type": "json",
34985+
"url": "https://example.com/webhook"
34986+
}
3495134987
}
3495234988
}
3495334989
}
@@ -49557,6 +49593,14 @@
4955749593
]
4955849594
}
4955949595
}
49596+
},
49597+
"examples": {
49598+
"default": {
49599+
"summary": "Example of setting permission to read",
49600+
"value": {
49601+
"permission": "read"
49602+
}
49603+
}
4956049604
}
4956149605
}
4956249606
}
@@ -49806,6 +49850,14 @@
4980649850
]
4980749851
}
4980849852
}
49853+
},
49854+
"examples": {
49855+
"default": {
49856+
"summary": "Example of setting permission to pull",
49857+
"value": {
49858+
"permission": "push"
49859+
}
49860+
}
4980949861
}
4981049862
}
4981149863
}
@@ -50070,6 +50122,15 @@
5007050122
"type": "string"
5007150123
}
5007250124
}
50125+
},
50126+
"examples": {
50127+
"default": {
50128+
"summary": "Example of updating blog and name",
50129+
"value": {
50130+
"blog": "https://github.com/blog",
50131+
"name": "monalisa octocat"
50132+
}
50133+
}
5007350134
}
5007450135
}
5007550136
}
@@ -50765,14 +50826,16 @@
5076550826
},
5076650827
"responses": {
5076750828
"201": {
50768-
"description": "Response after successfully creaing a secret",
50829+
"description": "Response after successfully creating a secret",
5076950830
"content": {
5077050831
"application/json": {
5077150832
"schema": {
50772-
"type": "object",
50773-
"properties": {
50774-
},
50775-
"additionalProperties": false
50833+
"$ref": "#/components/schemas/empty-object"
50834+
},
50835+
"examples": {
50836+
"default": {
50837+
"value": null
50838+
}
5077650839
}
5077750840
}
5077850841
}
@@ -52709,6 +52772,14 @@
5270952772
"application/json": {
5271052773
"schema": {
5271152774
"$ref": "#/components/schemas/interaction-limit"
52775+
},
52776+
"examples": {
52777+
"default": {
52778+
"value": {
52779+
"limit": "collaborators_only",
52780+
"expiry": "one_month"
52781+
}
52782+
}
5271252783
}
5271352784
}
5271452785
}

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

Lines changed: 59 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17997,6 +17997,11 @@ paths:
1799717997
- type: array
1799817998
items:
1799917999
type: string
18000+
examples:
18001+
default:
18002+
value:
18003+
apps:
18004+
- octoapp
1800018005
responses:
1800118006
'200':
1800218007
description: Response
@@ -18058,6 +18063,11 @@ paths:
1805818063
- type: array
1805918064
items:
1806018065
type: string
18066+
examples:
18067+
default:
18068+
value:
18069+
apps:
18070+
- octoapp
1806118071
responses:
1806218072
'200':
1806318073
description: Response
@@ -18118,6 +18128,11 @@ paths:
1811818128
- type: array
1811918129
items:
1812018130
type: string
18131+
examples:
18132+
default:
18133+
value:
18134+
apps:
18135+
- my-app
1812118136
responses:
1812218137
'200':
1812318138
description: Response
@@ -19333,9 +19348,10 @@ paths:
1933319348
content:
1933419349
application/json:
1933519350
schema:
19336-
type: object
19337-
properties: {}
19338-
additionalProperties: false
19351+
"$ref": "#/components/schemas/empty-object"
19352+
examples:
19353+
default:
19354+
value:
1933919355
'403':
1934019356
description: Forbidden if the check run is not rerequestable or doesn't
1934119357
belong to the authenticated GitHub App
@@ -19592,9 +19608,10 @@ paths:
1959219608
content:
1959319609
application/json:
1959419610
schema:
19595-
type: object
19596-
properties: {}
19597-
additionalProperties: false
19611+
"$ref": "#/components/schemas/empty-object"
19612+
examples:
19613+
default:
19614+
value:
1959819615
x-github:
1959919616
githubCloudOnly: false
1960019617
enabledForGitHubApps: true
@@ -20946,9 +20963,10 @@ paths:
2094620963
content:
2094720964
application/json:
2094820965
schema:
20949-
type: object
20950-
properties: {}
20951-
additionalProperties: false
20966+
"$ref": "#/components/schemas/empty-object"
20967+
examples:
20968+
default:
20969+
value:
2095220970
'204':
2095320971
description: Response when updating a secret
2095420972
x-github:
@@ -25513,11 +25531,12 @@ paths:
2551325531
"$ref": "#/components/schemas/webhook-config-secret"
2551425532
insecure_ssl:
2551525533
"$ref": "#/components/schemas/webhook-config-insecure-ssl"
25516-
example:
25517-
content_type: json
25518-
insecure_ssl: '0'
25519-
secret: "********"
25520-
url: https://example.com/webhook
25534+
examples:
25535+
default:
25536+
summary: Example of updating content type and URL
25537+
value:
25538+
content_type: json
25539+
url: https://example.com/webhook
2552125540
responses:
2552225541
'200':
2552325542
description: Response
@@ -35683,6 +35702,11 @@ paths:
3568335702
- read
3568435703
- write
3568535704
- admin
35705+
examples:
35706+
default:
35707+
summary: Example of setting permission to read
35708+
value:
35709+
permission: read
3568635710
responses:
3568735711
'204':
3568835712
description: Response
@@ -35862,6 +35886,11 @@ paths:
3586235886
- pull
3586335887
- push
3586435888
- admin
35889+
examples:
35890+
default:
35891+
summary: Example of setting permission to pull
35892+
value:
35893+
permission: push
3586535894
responses:
3586635895
'204':
3586735896
description: Response
@@ -36047,6 +36076,12 @@ paths:
3604736076
bio:
3604836077
description: The new short biography of the user.
3604936078
type: string
36079+
examples:
36080+
default:
36081+
summary: Example of updating blog and name
36082+
value:
36083+
blog: https://github.com/blog
36084+
name: monalisa octocat
3605036085
responses:
3605136086
'200':
3605236087
description: Response
@@ -36623,13 +36658,14 @@ paths:
3662336658
- '2345678'
3662436659
responses:
3662536660
'201':
36626-
description: Response after successfully creaing a secret
36661+
description: Response after successfully creating a secret
3662736662
content:
3662836663
application/json:
3662936664
schema:
36630-
type: object
36631-
properties: {}
36632-
additionalProperties: false
36665+
"$ref": "#/components/schemas/empty-object"
36666+
examples:
36667+
default:
36668+
value:
3663336669
'204':
3663436670
description: Response after successfully updating a secret
3663536671
'422':
@@ -37995,6 +38031,11 @@ paths:
3799538031
application/json:
3799638032
schema:
3799738033
"$ref": "#/components/schemas/interaction-limit"
38034+
examples:
38035+
default:
38036+
value:
38037+
limit: collaborators_only
38038+
expiry: one_month
3799838039
responses:
3799938040
'200':
3800038041
description: Response

0 commit comments

Comments
 (0)