Skip to content

Commit 69abb24

Browse files
mattpagemattpage
authored
Merge pull request #1585 from github/openapi-update-097648d69fa9c2bfd1e1c0ee5d4a321239d1a676a65d9718dc37f430b9092e77
Update OpenAPI 3.1 Descriptions
2 parents 7cf619b + a896348 commit 69abb24

32 files changed

+8747
-10049
lines changed

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

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33718,6 +33718,18 @@
3371833718
},
3371933719
"insecure_ssl": {
3372033720
"$ref": "#/components/schemas/webhook-config-insecure-ssl"
33721+
},
33722+
"token": {
33723+
"type": "string",
33724+
"examples": [
33725+
"\"abc\""
33726+
]
33727+
},
33728+
"digest": {
33729+
"type": "string",
33730+
"examples": [
33731+
"\"sha256\""
33732+
]
3372133733
}
3372233734
}
3372333735
},
@@ -39523,6 +39535,9 @@
3952339535
},
3952439536
"400": {
3952539537
"$ref": "#/components/responses/bad_request"
39538+
},
39539+
"409": {
39540+
"$ref": "#/components/responses/conflict"
3952639541
}
3952739542
},
3952839543
"x-github": {
@@ -39559,6 +39574,9 @@
3955939574
},
3956039575
"404": {
3956139576
"$ref": "#/components/responses/not_found"
39577+
},
39578+
"409": {
39579+
"$ref": "#/components/responses/conflict"
3956239580
}
3956339581
},
3956439582
"x-github": {
@@ -76699,8 +76717,20 @@
7669976717
"content_type": {
7670076718
"$ref": "#/components/schemas/webhook-config-content-type"
7670176719
},
76720+
"digest": {
76721+
"type": "string",
76722+
"examples": [
76723+
"\"sha256\""
76724+
]
76725+
},
7670276726
"secret": {
7670376727
"$ref": "#/components/schemas/webhook-config-secret"
76728+
},
76729+
"token": {
76730+
"type": "string",
76731+
"examples": [
76732+
"\"abc\""
76733+
]
7670476734
}
7670576735
}
7670676736
},

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24680,6 +24680,14 @@ paths:
2468024680
"$ref": "#/components/schemas/webhook-config-secret"
2468124681
insecure_ssl:
2468224682
"$ref": "#/components/schemas/webhook-config-insecure-ssl"
24683+
token:
24684+
type: string
24685+
examples:
24686+
- '"abc"'
24687+
digest:
24688+
type: string
24689+
examples:
24690+
- '"sha256"'
2468324691
events:
2468424692
type: array
2468524693
description: Determines what [events](https://docs.github.com/webhooks/event-payloads)
@@ -28545,6 +28553,8 @@ paths:
2854528553
"$ref": "#/components/responses/validation_failed"
2854628554
'400':
2854728555
"$ref": "#/components/responses/bad_request"
28556+
'409':
28557+
"$ref": "#/components/responses/conflict"
2854828558
x-github:
2854928559
githubCloudOnly: false
2855028560
enabledForGitHubApps: true
@@ -28568,6 +28578,8 @@ paths:
2856828578
"$ref": "#/components/responses/validation_failed"
2856928579
'404':
2857028580
"$ref": "#/components/responses/not_found"
28581+
'409':
28582+
"$ref": "#/components/responses/conflict"
2857128583
x-github:
2857228584
githubCloudOnly: false
2857328585
enabledForGitHubApps: true
@@ -55338,8 +55350,16 @@ components:
5533855350
"$ref": "#/components/schemas/webhook-config-insecure-ssl"
5533955351
content_type:
5534055352
"$ref": "#/components/schemas/webhook-config-content-type"
55353+
digest:
55354+
type: string
55355+
examples:
55356+
- '"sha256"'
5534155357
secret:
5534255358
"$ref": "#/components/schemas/webhook-config-secret"
55359+
token:
55360+
type: string
55361+
examples:
55362+
- '"abc"'
5534355363
updated_at:
5534455364
type: string
5534555365
format: date-time

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

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -310986,12 +310986,24 @@
310986310986
"\"json\""
310987310987
]
310988310988
},
310989+
"digest": {
310990+
"type": "string",
310991+
"examples": [
310992+
"\"sha256\""
310993+
]
310994+
},
310989310995
"secret": {
310990310996
"type": "string",
310991310997
"description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).",
310992310998
"examples": [
310993310999
"\"********\""
310994311000
]
311001+
},
311002+
"token": {
311003+
"type": "string",
311004+
"examples": [
311005+
"\"abc\""
311006+
]
310995311007
}
310996311008
}
310997311009
},
@@ -311244,6 +311256,18 @@
311244311256
"type": "number"
311245311257
}
311246311258
]
311259+
},
311260+
"token": {
311261+
"type": "string",
311262+
"examples": [
311263+
"\"abc\""
311264+
]
311265+
},
311266+
"digest": {
311267+
"type": "string",
311268+
"examples": [
311269+
"\"sha256\""
311270+
]
311247311271
}
311248311272
}
311249311273
},
@@ -311386,12 +311410,24 @@
311386311410
"\"json\""
311387311411
]
311388311412
},
311413+
"digest": {
311414+
"type": "string",
311415+
"examples": [
311416+
"\"sha256\""
311417+
]
311418+
},
311389311419
"secret": {
311390311420
"type": "string",
311391311421
"description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).",
311392311422
"examples": [
311393311423
"\"********\""
311394311424
]
311425+
},
311426+
"token": {
311427+
"type": "string",
311428+
"examples": [
311429+
"\"abc\""
311430+
]
311395311431
}
311396311432
}
311397311433
},
@@ -311801,12 +311837,24 @@
311801311837
"\"json\""
311802311838
]
311803311839
},
311840+
"digest": {
311841+
"type": "string",
311842+
"examples": [
311843+
"\"sha256\""
311844+
]
311845+
},
311804311846
"secret": {
311805311847
"type": "string",
311806311848
"description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).",
311807311849
"examples": [
311808311850
"\"********\""
311809311851
]
311852+
},
311853+
"token": {
311854+
"type": "string",
311855+
"examples": [
311856+
"\"abc\""
311857+
]
311810311858
}
311811311859
}
311812311860
},
@@ -312213,12 +312261,24 @@
312213312261
"\"json\""
312214312262
]
312215312263
},
312264+
"digest": {
312265+
"type": "string",
312266+
"examples": [
312267+
"\"sha256\""
312268+
]
312269+
},
312216312270
"secret": {
312217312271
"type": "string",
312218312272
"description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).",
312219312273
"examples": [
312220312274
"\"********\""
312221312275
]
312276+
},
312277+
"token": {
312278+
"type": "string",
312279+
"examples": [
312280+
"\"abc\""
312281+
]
312222312282
}
312223312283
}
312224312284
},
@@ -396328,6 +396388,32 @@
396328396388
}
396329396389
}
396330396390
}
396391+
},
396392+
"409": {
396393+
"description": "Conflict",
396394+
"content": {
396395+
"application/json": {
396396+
"schema": {
396397+
"title": "Basic Error",
396398+
"description": "Basic Error",
396399+
"type": "object",
396400+
"properties": {
396401+
"message": {
396402+
"type": "string"
396403+
},
396404+
"documentation_url": {
396405+
"type": "string"
396406+
},
396407+
"url": {
396408+
"type": "string"
396409+
},
396410+
"status": {
396411+
"type": "string"
396412+
}
396413+
}
396414+
}
396415+
}
396416+
}
396331396417
}
396332396418
},
396333396419
"x-github": {
@@ -396471,6 +396557,32 @@
396471396557
}
396472396558
}
396473396559
}
396560+
},
396561+
"409": {
396562+
"description": "Conflict",
396563+
"content": {
396564+
"application/json": {
396565+
"schema": {
396566+
"title": "Basic Error",
396567+
"description": "Basic Error",
396568+
"type": "object",
396569+
"properties": {
396570+
"message": {
396571+
"type": "string"
396572+
},
396573+
"documentation_url": {
396574+
"type": "string"
396575+
},
396576+
"url": {
396577+
"type": "string"
396578+
},
396579+
"status": {
396580+
"type": "string"
396581+
}
396582+
}
396583+
}
396584+
}
396585+
}
396474396586
}
396475396587
},
396476396588
"x-github": {

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52256,7 +52256,15 @@ paths:
5225652256
url: *2
5225752257
insecure_ssl: *5
5225852258
content_type: *3
52259+
digest:
52260+
type: string
52261+
examples:
52262+
- '"sha256"'
5225952263
secret: *4
52264+
token:
52265+
type: string
52266+
examples:
52267+
- '"abc"'
5226052268
updated_at:
5226152269
type: string
5226252270
format: date-time
@@ -52388,6 +52396,14 @@ paths:
5238852396
content_type: *3
5238952397
secret: *4
5239052398
insecure_ssl: *5
52399+
token:
52400+
type: string
52401+
examples:
52402+
- '"abc"'
52403+
digest:
52404+
type: string
52405+
examples:
52406+
- '"sha256"'
5239152407
events:
5239252408
type: array
5239352409
description: Determines what [events](https://docs.github.com/webhooks/event-payloads)
@@ -59529,6 +59545,7 @@ paths:
5952959545
description: Response
5953059546
'422': *10
5953159547
'400': *9
59548+
'409': *219
5953259549
x-github:
5953359550
githubCloudOnly: false
5953459551
enabledForGitHubApps: true
@@ -59550,6 +59567,7 @@ paths:
5955059567
description: Response
5955159568
'422': *10
5955259569
'404': *15
59570+
'409': *219
5955359571
x-github:
5955459572
githubCloudOnly: false
5955559573
enabledForGitHubApps: true

0 commit comments

Comments
 (0)