Skip to content

Commit 0feaa67

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #1699 from github/openapi-update-35cbbf2bbc328e112d72d0c9d11a5daa83f9cf3d087a163dfc2af3841426ff9c
Update OpenAPI 3.0 Descriptions
2 parents 75f8ac9 + 067531c commit 0feaa67

32 files changed

Lines changed: 2257 additions & 393 deletions

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

Lines changed: 94 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -24925,6 +24925,15 @@
2492524925
}
2492624926
}
2492724927
]
24928+
},
24929+
"examples": {
24930+
"default": {
24931+
"value": {
24932+
"apps": [
24933+
"octoapp"
24934+
]
24935+
}
24936+
}
2492824937
}
2492924938
}
2493024939
}
@@ -25015,6 +25024,15 @@
2501525024
}
2501625025
}
2501725026
]
25027+
},
25028+
"examples": {
25029+
"default": {
25030+
"value": {
25031+
"apps": [
25032+
"octoapp"
25033+
]
25034+
}
25035+
}
2501825036
}
2501925037
}
2502025038
}
@@ -25104,6 +25122,15 @@
2510425122
}
2510525123
}
2510625124
]
25125+
},
25126+
"examples": {
25127+
"default": {
25128+
"value": {
25129+
"apps": [
25130+
"my-app"
25131+
]
25132+
}
25133+
}
2510725134
}
2510825135
}
2510925136
}
@@ -26722,10 +26749,12 @@
2672226749
"content": {
2672326750
"application/json": {
2672426751
"schema": {
26725-
"type": "object",
26726-
"properties": {
26727-
},
26728-
"additionalProperties": false
26752+
"$ref": "#/components/schemas/empty-object"
26753+
},
26754+
"examples": {
26755+
"default": {
26756+
"value": null
26757+
}
2672926758
}
2673026759
}
2673126760
}
@@ -27110,10 +27139,12 @@
2711027139
"content": {
2711127140
"application/json": {
2711227141
"schema": {
27113-
"type": "object",
27114-
"properties": {
27115-
},
27116-
"additionalProperties": false
27142+
"$ref": "#/components/schemas/empty-object"
27143+
},
27144+
"examples": {
27145+
"default": {
27146+
"value": null
27147+
}
2711727148
}
2711827149
}
2711927150
}
@@ -28762,10 +28793,12 @@
2876228793
"content": {
2876328794
"application/json": {
2876428795
"schema": {
28765-
"type": "object",
28766-
"properties": {
28767-
},
28768-
"additionalProperties": false
28796+
"$ref": "#/components/schemas/empty-object"
28797+
},
28798+
"examples": {
28799+
"default": {
28800+
"value": null
28801+
}
2876928802
}
2877028803
}
2877128804
}
@@ -34760,12 +34793,15 @@
3476034793
"insecure_ssl": {
3476134794
"$ref": "#/components/schemas/webhook-config-insecure-ssl"
3476234795
}
34763-
},
34764-
"example": {
34765-
"content_type": "json",
34766-
"insecure_ssl": "0",
34767-
"secret": "********",
34768-
"url": "https://example.com/webhook"
34796+
}
34797+
},
34798+
"examples": {
34799+
"default": {
34800+
"summary": "Example of updating content type and URL",
34801+
"value": {
34802+
"content_type": "json",
34803+
"url": "https://example.com/webhook"
34804+
}
3476934805
}
3477034806
}
3477134807
}
@@ -49304,6 +49340,14 @@
4930449340
]
4930549341
}
4930649342
}
49343+
},
49344+
"examples": {
49345+
"default": {
49346+
"summary": "Example of setting permission to read",
49347+
"value": {
49348+
"permission": "read"
49349+
}
49350+
}
4930749351
}
4930849352
}
4930949353
}
@@ -49553,6 +49597,14 @@
4955349597
]
4955449598
}
4955549599
}
49600+
},
49601+
"examples": {
49602+
"default": {
49603+
"summary": "Example of setting permission to pull",
49604+
"value": {
49605+
"permission": "push"
49606+
}
49607+
}
4955649608
}
4955749609
}
4955849610
}
@@ -49803,6 +49855,15 @@
4980349855
"type": "string"
4980449856
}
4980549857
}
49858+
},
49859+
"examples": {
49860+
"default": {
49861+
"summary": "Example of updating blog and name",
49862+
"value": {
49863+
"blog": "https://github.com/blog",
49864+
"name": "monalisa octocat"
49865+
}
49866+
}
4980649867
}
4980749868
}
4980849869
}
@@ -50498,14 +50559,16 @@
5049850559
},
5049950560
"responses": {
5050050561
"201": {
50501-
"description": "Response after successfully creaing a secret",
50562+
"description": "Response after successfully creating a secret",
5050250563
"content": {
5050350564
"application/json": {
5050450565
"schema": {
50505-
"type": "object",
50506-
"properties": {
50507-
},
50508-
"additionalProperties": false
50566+
"$ref": "#/components/schemas/empty-object"
50567+
},
50568+
"examples": {
50569+
"default": {
50570+
"value": null
50571+
}
5050950572
}
5051050573
}
5051150574
}
@@ -52434,6 +52497,14 @@
5243452497
"application/json": {
5243552498
"schema": {
5243652499
"$ref": "#/components/schemas/interaction-limit"
52500+
},
52501+
"examples": {
52502+
"default": {
52503+
"value": {
52504+
"limit": "collaborators_only",
52505+
"expiry": "one_month"
52506+
}
52507+
}
5243752508
}
5243852509
}
5243952510
}

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

Lines changed: 59 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17933,6 +17933,11 @@ paths:
1793317933
- type: array
1793417934
items:
1793517935
type: string
17936+
examples:
17937+
default:
17938+
value:
17939+
apps:
17940+
- octoapp
1793617941
responses:
1793717942
'200':
1793817943
description: Response
@@ -17994,6 +17999,11 @@ paths:
1799417999
- type: array
1799518000
items:
1799618001
type: string
18002+
examples:
18003+
default:
18004+
value:
18005+
apps:
18006+
- octoapp
1799718007
responses:
1799818008
'200':
1799918009
description: Response
@@ -18054,6 +18064,11 @@ paths:
1805418064
- type: array
1805518065
items:
1805618066
type: string
18067+
examples:
18068+
default:
18069+
value:
18070+
apps:
18071+
- my-app
1805718072
responses:
1805818073
'200':
1805918074
description: Response
@@ -19269,9 +19284,10 @@ paths:
1926919284
content:
1927019285
application/json:
1927119286
schema:
19272-
type: object
19273-
properties: {}
19274-
additionalProperties: false
19287+
"$ref": "#/components/schemas/empty-object"
19288+
examples:
19289+
default:
19290+
value:
1927519291
'403':
1927619292
description: Forbidden if the check run is not rerequestable or doesn't
1927719293
belong to the authenticated GitHub App
@@ -19528,9 +19544,10 @@ paths:
1952819544
content:
1952919545
application/json:
1953019546
schema:
19531-
type: object
19532-
properties: {}
19533-
additionalProperties: false
19547+
"$ref": "#/components/schemas/empty-object"
19548+
examples:
19549+
default:
19550+
value:
1953419551
x-github:
1953519552
githubCloudOnly: false
1953619553
enabledForGitHubApps: true
@@ -20875,9 +20892,10 @@ paths:
2087520892
content:
2087620893
application/json:
2087720894
schema:
20878-
type: object
20879-
properties: {}
20880-
additionalProperties: false
20895+
"$ref": "#/components/schemas/empty-object"
20896+
examples:
20897+
default:
20898+
value:
2088120899
'204':
2088220900
description: Response when updating a secret
2088320901
x-github:
@@ -25425,11 +25443,12 @@ paths:
2542525443
"$ref": "#/components/schemas/webhook-config-secret"
2542625444
insecure_ssl:
2542725445
"$ref": "#/components/schemas/webhook-config-insecure-ssl"
25428-
example:
25429-
content_type: json
25430-
insecure_ssl: '0'
25431-
secret: "********"
25432-
url: https://example.com/webhook
25446+
examples:
25447+
default:
25448+
summary: Example of updating content type and URL
25449+
value:
25450+
content_type: json
25451+
url: https://example.com/webhook
2543325452
responses:
2543425453
'200':
2543525454
description: Response
@@ -35556,6 +35575,11 @@ paths:
3555635575
- read
3555735576
- write
3555835577
- admin
35578+
examples:
35579+
default:
35580+
summary: Example of setting permission to read
35581+
value:
35582+
permission: read
3555935583
responses:
3556035584
'204':
3556135585
description: Response
@@ -35735,6 +35759,11 @@ paths:
3573535759
- pull
3573635760
- push
3573735761
- admin
35762+
examples:
35763+
default:
35764+
summary: Example of setting permission to pull
35765+
value:
35766+
permission: push
3573835767
responses:
3573935768
'204':
3574035769
description: Response
@@ -35913,6 +35942,12 @@ paths:
3591335942
bio:
3591435943
description: The new short biography of the user.
3591535944
type: string
35945+
examples:
35946+
default:
35947+
summary: Example of updating blog and name
35948+
value:
35949+
blog: https://github.com/blog
35950+
name: monalisa octocat
3591635951
responses:
3591735952
'200':
3591835953
description: Response
@@ -36489,13 +36524,14 @@ paths:
3648936524
- '2345678'
3649036525
responses:
3649136526
'201':
36492-
description: Response after successfully creaing a secret
36527+
description: Response after successfully creating a secret
3649336528
content:
3649436529
application/json:
3649536530
schema:
36496-
type: object
36497-
properties: {}
36498-
additionalProperties: false
36531+
"$ref": "#/components/schemas/empty-object"
36532+
examples:
36533+
default:
36534+
value:
3649936535
'204':
3650036536
description: Response after successfully updating a secret
3650136537
'422':
@@ -37857,6 +37893,11 @@ paths:
3785737893
application/json:
3785837894
schema:
3785937895
"$ref": "#/components/schemas/interaction-limit"
37896+
examples:
37897+
default:
37898+
value:
37899+
limit: collaborators_only
37900+
expiry: one_month
3786037901
responses:
3786137902
'200':
3786237903
description: Response

0 commit comments

Comments
 (0)