Skip to content

Commit ee8353d

Browse files
mattpagemattpage
authored
Merge pull request #1584 from github/openapi-update-ed89584427b691cfd05b5173fd0896cb0d3c916b96523ff280c34b169a9458a6
Update OpenAPI 3.0 Descriptions
2 parents 69abb24 + a64b09b commit ee8353d

32 files changed

Lines changed: 8703 additions & 10275 deletions

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33544,6 +33544,14 @@
3354433544
},
3354533545
"insecure_ssl": {
3354633546
"$ref": "#/components/schemas/webhook-config-insecure-ssl"
33547+
},
33548+
"token": {
33549+
"type": "string",
33550+
"example": "\"abc\""
33551+
},
33552+
"digest": {
33553+
"type": "string",
33554+
"example": "\"sha256\""
3354733555
}
3354833556
}
3354933557
},
@@ -39302,6 +39310,9 @@
3930239310
},
3930339311
"400": {
3930439312
"$ref": "#/components/responses/bad_request"
39313+
},
39314+
"409": {
39315+
"$ref": "#/components/responses/conflict"
3930539316
}
3930639317
},
3930739318
"x-github": {
@@ -39338,6 +39349,9 @@
3933839349
},
3933939350
"404": {
3934039351
"$ref": "#/components/responses/not_found"
39352+
},
39353+
"409": {
39354+
"$ref": "#/components/responses/conflict"
3934139355
}
3934239356
},
3934339357
"x-github": {
@@ -74867,8 +74881,16 @@
7486774881
"content_type": {
7486874882
"$ref": "#/components/schemas/webhook-config-content-type"
7486974883
},
74884+
"digest": {
74885+
"type": "string",
74886+
"example": "\"sha256\""
74887+
},
7487074888
"secret": {
7487174889
"$ref": "#/components/schemas/webhook-config-secret"
74890+
},
74891+
"token": {
74892+
"type": "string",
74893+
"example": "\"abc\""
7487274894
}
7487374895
}
7487474896
},

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24596,6 +24596,12 @@ paths:
2459624596
"$ref": "#/components/schemas/webhook-config-secret"
2459724597
insecure_ssl:
2459824598
"$ref": "#/components/schemas/webhook-config-insecure-ssl"
24599+
token:
24600+
type: string
24601+
example: '"abc"'
24602+
digest:
24603+
type: string
24604+
example: '"sha256"'
2459924605
events:
2460024606
type: array
2460124607
description: Determines what [events](https://docs.github.com/webhooks/event-payloads)
@@ -28434,6 +28440,8 @@ paths:
2843428440
"$ref": "#/components/responses/validation_failed"
2843528441
'400':
2843628442
"$ref": "#/components/responses/bad_request"
28443+
'409':
28444+
"$ref": "#/components/responses/conflict"
2843728445
x-github:
2843828446
githubCloudOnly: false
2843928447
enabledForGitHubApps: true
@@ -28457,6 +28465,8 @@ paths:
2845728465
"$ref": "#/components/responses/validation_failed"
2845828466
'404':
2845928467
"$ref": "#/components/responses/not_found"
28468+
'409':
28469+
"$ref": "#/components/responses/conflict"
2846028470
x-github:
2846128471
githubCloudOnly: false
2846228472
enabledForGitHubApps: true
@@ -55121,8 +55131,14 @@ components:
5512155131
"$ref": "#/components/schemas/webhook-config-insecure-ssl"
5512255132
content_type:
5512355133
"$ref": "#/components/schemas/webhook-config-content-type"
55134+
digest:
55135+
type: string
55136+
example: '"sha256"'
5512455137
secret:
5512555138
"$ref": "#/components/schemas/webhook-config-secret"
55139+
token:
55140+
type: string
55141+
example: '"abc"'
5512655142
updated_at:
5512755143
type: string
5512855144
format: date-time

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

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263082,10 +263082,18 @@
263082263082
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
263083263083
"example": "\"json\""
263084263084
},
263085+
"digest": {
263086+
"type": "string",
263087+
"example": "\"sha256\""
263088+
},
263085263089
"secret": {
263086263090
"type": "string",
263087263091
"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).",
263088263092
"example": "\"********\""
263093+
},
263094+
"token": {
263095+
"type": "string",
263096+
"example": "\"abc\""
263089263097
}
263090263098
}
263091263099
},
@@ -263310,6 +263318,14 @@
263310263318
"type": "number"
263311263319
}
263312263320
]
263321+
},
263322+
"token": {
263323+
"type": "string",
263324+
"example": "\"abc\""
263325+
},
263326+
"digest": {
263327+
"type": "string",
263328+
"example": "\"sha256\""
263313263329
}
263314263330
}
263315263331
},
@@ -263432,10 +263448,18 @@
263432263448
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
263433263449
"example": "\"json\""
263434263450
},
263451+
"digest": {
263452+
"type": "string",
263453+
"example": "\"sha256\""
263454+
},
263435263455
"secret": {
263436263456
"type": "string",
263437263457
"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).",
263438263458
"example": "\"********\""
263459+
},
263460+
"token": {
263461+
"type": "string",
263462+
"example": "\"abc\""
263439263463
}
263440263464
}
263441263465
},
@@ -263801,10 +263825,18 @@
263801263825
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
263802263826
"example": "\"json\""
263803263827
},
263828+
"digest": {
263829+
"type": "string",
263830+
"example": "\"sha256\""
263831+
},
263804263832
"secret": {
263805263833
"type": "string",
263806263834
"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).",
263807263835
"example": "\"********\""
263836+
},
263837+
"token": {
263838+
"type": "string",
263839+
"example": "\"abc\""
263808263840
}
263809263841
}
263810263842
},
@@ -264161,10 +264193,18 @@
264161264193
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
264162264194
"example": "\"json\""
264163264195
},
264196+
"digest": {
264197+
"type": "string",
264198+
"example": "\"sha256\""
264199+
},
264164264200
"secret": {
264165264201
"type": "string",
264166264202
"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).",
264167264203
"example": "\"********\""
264204+
},
264205+
"token": {
264206+
"type": "string",
264207+
"example": "\"abc\""
264168264208
}
264169264209
}
264170264210
},
@@ -332262,6 +332302,32 @@
332262332302
}
332263332303
}
332264332304
}
332305+
},
332306+
"409": {
332307+
"description": "Conflict",
332308+
"content": {
332309+
"application/json": {
332310+
"schema": {
332311+
"title": "Basic Error",
332312+
"description": "Basic Error",
332313+
"type": "object",
332314+
"properties": {
332315+
"message": {
332316+
"type": "string"
332317+
},
332318+
"documentation_url": {
332319+
"type": "string"
332320+
},
332321+
"url": {
332322+
"type": "string"
332323+
},
332324+
"status": {
332325+
"type": "string"
332326+
}
332327+
}
332328+
}
332329+
}
332330+
}
332265332331
}
332266332332
},
332267332333
"x-github": {
@@ -332399,6 +332465,32 @@
332399332465
}
332400332466
}
332401332467
}
332468+
},
332469+
"409": {
332470+
"description": "Conflict",
332471+
"content": {
332472+
"application/json": {
332473+
"schema": {
332474+
"title": "Basic Error",
332475+
"description": "Basic Error",
332476+
"type": "object",
332477+
"properties": {
332478+
"message": {
332479+
"type": "string"
332480+
},
332481+
"documentation_url": {
332482+
"type": "string"
332483+
},
332484+
"url": {
332485+
"type": "string"
332486+
},
332487+
"status": {
332488+
"type": "string"
332489+
}
332490+
}
332491+
}
332492+
}
332493+
}
332402332494
}
332403332495
},
332404332496
"x-github": {

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50892,7 +50892,13 @@ paths:
5089250892
url: *2
5089350893
insecure_ssl: *5
5089450894
content_type: *3
50895+
digest:
50896+
type: string
50897+
example: '"sha256"'
5089550898
secret: *4
50899+
token:
50900+
type: string
50901+
example: '"abc"'
5089650902
updated_at:
5089750903
type: string
5089850904
format: date-time
@@ -51014,6 +51020,12 @@ paths:
5101451020
content_type: *3
5101551021
secret: *4
5101651022
insecure_ssl: *5
51023+
token:
51024+
type: string
51025+
example: '"abc"'
51026+
digest:
51027+
type: string
51028+
example: '"sha256"'
5101751029
events:
5101851030
type: array
5101951031
description: Determines what [events](https://docs.github.com/webhooks/event-payloads)
@@ -58131,6 +58143,7 @@ paths:
5813158143
description: Response
5813258144
'422': *10
5813358145
'400': *9
58146+
'409': *228
5813458147
x-github:
5813558148
githubCloudOnly: false
5813658149
enabledForGitHubApps: true
@@ -58152,6 +58165,7 @@ paths:
5815258165
description: Response
5815358166
'422': *10
5815458167
'404': *16
58168+
'409': *228
5815558169
x-github:
5815658170
githubCloudOnly: false
5815758171
enabledForGitHubApps: true

0 commit comments

Comments
 (0)