Skip to content

Commit 377200d

Browse files
mmrobinsmmrobins
authored
Merge pull request #1575 from github/openapi-update-c5f644139563fa928085801fa419bf5a511fd499d8c791927c0ad0621009834d
Update OpenAPI 3.1 Descriptions
2 parents 99f856c + e3ee366 commit 377200d

32 files changed

Lines changed: 88 additions & 932 deletions

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

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -33718,18 +33718,6 @@
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-
]
3373333721
}
3373433722
}
3373533723
},
@@ -75445,6 +75433,15 @@
7544575433
"advisory_url"
7544675434
]
7544775435
}
75436+
},
75437+
"scope": {
75438+
"description": "Where the dependency is utilized. `development` means that the dependency is only utilized in the development environment. `runtime` means that the dependency is utilized at runtime and in the development environment.",
75439+
"type": "string",
75440+
"enum": [
75441+
"unknown",
75442+
"runtime",
75443+
"development"
75444+
]
7544875445
}
7544975446
},
7545075447
"required": [
@@ -75456,7 +75453,8 @@
7545675453
"package_url",
7545775454
"license",
7545875455
"source_repository_url",
75459-
"vulnerabilities"
75456+
"vulnerabilities",
75457+
"scope"
7546075458
]
7546175459
}
7546275460
},
@@ -76688,20 +76686,8 @@
7668876686
"content_type": {
7668976687
"$ref": "#/components/schemas/webhook-config-content-type"
7669076688
},
76691-
"digest": {
76692-
"type": "string",
76693-
"examples": [
76694-
"\"sha256\""
76695-
]
76696-
},
7669776689
"secret": {
7669876690
"$ref": "#/components/schemas/webhook-config-secret"
76699-
},
76700-
"token": {
76701-
"type": "string",
76702-
"examples": [
76703-
"\"abc\""
76704-
]
7670576691
}
7670676692
}
7670776693
},

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

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -24680,14 +24680,6 @@ 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"'
2469124683
events:
2469224684
type: array
2469324685
description: Determines what [events](https://docs.github.com/webhooks/event-payloads)
@@ -54411,6 +54403,16 @@ components:
5441154403
- advisory_ghsa_id
5441254404
- advisory_summary
5441354405
- advisory_url
54406+
scope:
54407+
description: Where the dependency is utilized. `development` means that
54408+
the dependency is only utilized in the development environment. `runtime`
54409+
means that the dependency is utilized at runtime and in the development
54410+
environment.
54411+
type: string
54412+
enum:
54413+
- unknown
54414+
- runtime
54415+
- development
5441454416
required:
5441554417
- change_type
5441654418
- manifest
@@ -54421,6 +54423,7 @@ components:
5442154423
- license
5442254424
- source_repository_url
5442354425
- vulnerabilities
54426+
- scope
5442454427
metadata:
5442554428
title: metadata
5442654429
description: User-defined metadata to store domain-specific information limited
@@ -55325,16 +55328,8 @@ components:
5532555328
"$ref": "#/components/schemas/webhook-config-insecure-ssl"
5532655329
content_type:
5532755330
"$ref": "#/components/schemas/webhook-config-content-type"
55328-
digest:
55329-
type: string
55330-
examples:
55331-
- '"sha256"'
5533255331
secret:
5533355332
"$ref": "#/components/schemas/webhook-config-secret"
55334-
token:
55335-
type: string
55336-
examples:
55337-
- '"abc"'
5533855333
updated_at:
5533955334
type: string
5534055335
format: date-time

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

Lines changed: 11 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -285866,6 +285866,15 @@
285866285866
"advisory_url"
285867285867
]
285868285868
}
285869+
},
285870+
"scope": {
285871+
"description": "Where the dependency is utilized. `development` means that the dependency is only utilized in the development environment. `runtime` means that the dependency is utilized at runtime and in the development environment.",
285872+
"type": "string",
285873+
"enum": [
285874+
"unknown",
285875+
"runtime",
285876+
"development"
285877+
]
285869285878
}
285870285879
},
285871285880
"required": [
@@ -285877,7 +285886,8 @@
285877285886
"package_url",
285878285887
"license",
285879285888
"source_repository_url",
285880-
"vulnerabilities"
285889+
"vulnerabilities",
285890+
"scope"
285881285891
]
285882285892
}
285883285893
},
@@ -310958,24 +310968,12 @@
310958310968
"\"json\""
310959310969
]
310960310970
},
310961-
"digest": {
310962-
"type": "string",
310963-
"examples": [
310964-
"\"sha256\""
310965-
]
310966-
},
310967310971
"secret": {
310968310972
"type": "string",
310969310973
"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).",
310970310974
"examples": [
310971310975
"\"********\""
310972310976
]
310973-
},
310974-
"token": {
310975-
"type": "string",
310976-
"examples": [
310977-
"\"abc\""
310978-
]
310979310977
}
310980310978
}
310981310979
},
@@ -311228,18 +311226,6 @@
311228311226
"type": "number"
311229311227
}
311230311228
]
311231-
},
311232-
"token": {
311233-
"type": "string",
311234-
"examples": [
311235-
"\"abc\""
311236-
]
311237-
},
311238-
"digest": {
311239-
"type": "string",
311240-
"examples": [
311241-
"\"sha256\""
311242-
]
311243311229
}
311244311230
}
311245311231
},
@@ -311382,24 +311368,12 @@
311382311368
"\"json\""
311383311369
]
311384311370
},
311385-
"digest": {
311386-
"type": "string",
311387-
"examples": [
311388-
"\"sha256\""
311389-
]
311390-
},
311391311371
"secret": {
311392311372
"type": "string",
311393311373
"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).",
311394311374
"examples": [
311395311375
"\"********\""
311396311376
]
311397-
},
311398-
"token": {
311399-
"type": "string",
311400-
"examples": [
311401-
"\"abc\""
311402-
]
311403311377
}
311404311378
}
311405311379
},
@@ -311809,24 +311783,12 @@
311809311783
"\"json\""
311810311784
]
311811311785
},
311812-
"digest": {
311813-
"type": "string",
311814-
"examples": [
311815-
"\"sha256\""
311816-
]
311817-
},
311818311786
"secret": {
311819311787
"type": "string",
311820311788
"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).",
311821311789
"examples": [
311822311790
"\"********\""
311823311791
]
311824-
},
311825-
"token": {
311826-
"type": "string",
311827-
"examples": [
311828-
"\"abc\""
311829-
]
311830311792
}
311831311793
}
311832311794
},
@@ -312233,24 +312195,12 @@
312233312195
"\"json\""
312234312196
]
312235312197
},
312236-
"digest": {
312237-
"type": "string",
312238-
"examples": [
312239-
"\"sha256\""
312240-
]
312241-
},
312242312198
"secret": {
312243312199
"type": "string",
312244312200
"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).",
312245312201
"examples": [
312246312202
"\"********\""
312247312203
]
312248-
},
312249-
"token": {
312250-
"type": "string",
312251-
"examples": [
312252-
"\"abc\""
312253-
]
312254312204
}
312255312205
}
312256312206
},

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

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -48702,6 +48702,16 @@ paths:
4870248702
- advisory_ghsa_id
4870348703
- advisory_summary
4870448704
- advisory_url
48705+
scope:
48706+
description: Where the dependency is utilized. `development`
48707+
means that the dependency is only utilized in the development
48708+
environment. `runtime` means that the dependency is utilized
48709+
at runtime and in the development environment.
48710+
type: string
48711+
enum:
48712+
- unknown
48713+
- runtime
48714+
- development
4870548715
required:
4870648716
- change_type
4870748717
- manifest
@@ -48712,6 +48722,7 @@ paths:
4871248722
- license
4871348723
- source_repository_url
4871448724
- vulnerabilities
48725+
- scope
4871548726
examples:
4871648727
default:
4871748728
value:
@@ -52237,15 +52248,7 @@ paths:
5223752248
url: *2
5223852249
insecure_ssl: *5
5223952250
content_type: *3
52240-
digest:
52241-
type: string
52242-
examples:
52243-
- '"sha256"'
5224452251
secret: *4
52245-
token:
52246-
type: string
52247-
examples:
52248-
- '"abc"'
5224952252
updated_at:
5225052253
type: string
5225152254
format: date-time
@@ -52377,14 +52380,6 @@ paths:
5237752380
content_type: *3
5237852381
secret: *4
5237952382
insecure_ssl: *5
52380-
token:
52381-
type: string
52382-
examples:
52383-
- '"abc"'
52384-
digest:
52385-
type: string
52386-
examples:
52387-
- '"sha256"'
5238852383
events:
5238952384
type: array
5239052385
description: Determines what [events](https://docs.github.com/webhooks/event-payloads)

0 commit comments

Comments
 (0)