Skip to content

Commit f4fdaa4

Browse files
mmrobinsmmrobins
authored
Merge pull request #1574 from github/openapi-update-8fd9f1d72be32b490cbc9e679516dd7b61ff6c156e86b90c7961d0e137e3d0e2
Update OpenAPI 3.0 Descriptions
2 parents 377200d + 4ae785b commit f4fdaa4

32 files changed

Lines changed: 88 additions & 644 deletions

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

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -33544,14 +33544,6 @@
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\""
3355533547
}
3355633548
}
3355733549
},
@@ -73800,6 +73792,15 @@
7380073792
"advisory_url"
7380173793
]
7380273794
}
73795+
},
73796+
"scope": {
73797+
"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.",
73798+
"type": "string",
73799+
"enum": [
73800+
"unknown",
73801+
"runtime",
73802+
"development"
73803+
]
7380373804
}
7380473805
},
7380573806
"required": [
@@ -73811,7 +73812,8 @@
7381173812
"package_url",
7381273813
"license",
7381373814
"source_repository_url",
73814-
"vulnerabilities"
73815+
"vulnerabilities",
73816+
"scope"
7381573817
]
7381673818
}
7381773819
},
@@ -74854,16 +74856,8 @@
7485474856
"content_type": {
7485574857
"$ref": "#/components/schemas/webhook-config-content-type"
7485674858
},
74857-
"digest": {
74858-
"type": "string",
74859-
"example": "\"sha256\""
74860-
},
7486174859
"secret": {
7486274860
"$ref": "#/components/schemas/webhook-config-secret"
74863-
},
74864-
"token": {
74865-
"type": "string",
74866-
"example": "\"abc\""
7486774861
}
7486874862
}
7486974863
},

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

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24596,12 +24596,6 @@ 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"'
2460524599
events:
2460624600
type: array
2460724601
description: Determines what [events](https://docs.github.com/webhooks/event-payloads)
@@ -54286,6 +54280,16 @@ components:
5428654280
- advisory_ghsa_id
5428754281
- advisory_summary
5428854282
- advisory_url
54283+
scope:
54284+
description: Where the dependency is utilized. `development` means that
54285+
the dependency is only utilized in the development environment. `runtime`
54286+
means that the dependency is utilized at runtime and in the development
54287+
environment.
54288+
type: string
54289+
enum:
54290+
- unknown
54291+
- runtime
54292+
- development
5428954293
required:
5429054294
- change_type
5429154295
- manifest
@@ -54296,6 +54300,7 @@ components:
5429654300
- license
5429754301
- source_repository_url
5429854302
- vulnerabilities
54303+
- scope
5429954304
metadata:
5430054305
title: metadata
5430154306
description: User-defined metadata to store domain-specific information limited
@@ -55107,14 +55112,8 @@ components:
5510755112
"$ref": "#/components/schemas/webhook-config-insecure-ssl"
5510855113
content_type:
5510955114
"$ref": "#/components/schemas/webhook-config-content-type"
55110-
digest:
55111-
type: string
55112-
example: '"sha256"'
5511355115
secret:
5511455116
"$ref": "#/components/schemas/webhook-config-secret"
55115-
token:
55116-
type: string
55117-
example: '"abc"'
5511855117
updated_at:
5511955118
type: string
5512055119
format: date-time

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

Lines changed: 11 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -241974,6 +241974,15 @@
241974241974
"advisory_url"
241975241975
]
241976241976
}
241977+
},
241978+
"scope": {
241979+
"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.",
241980+
"type": "string",
241981+
"enum": [
241982+
"unknown",
241983+
"runtime",
241984+
"development"
241985+
]
241977241986
}
241978241987
},
241979241988
"required": [
@@ -241985,7 +241994,8 @@
241985241994
"package_url",
241986241995
"license",
241987241996
"source_repository_url",
241988-
"vulnerabilities"
241997+
"vulnerabilities",
241998+
"scope"
241989241999
]
241990242000
}
241991242001
},
@@ -263058,18 +263068,10 @@
263058263068
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
263059263069
"example": "\"json\""
263060263070
},
263061-
"digest": {
263062-
"type": "string",
263063-
"example": "\"sha256\""
263064-
},
263065263071
"secret": {
263066263072
"type": "string",
263067263073
"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).",
263068263074
"example": "\"********\""
263069-
},
263070-
"token": {
263071-
"type": "string",
263072-
"example": "\"abc\""
263073263075
}
263074263076
}
263075263077
},
@@ -263294,14 +263296,6 @@
263294263296
"type": "number"
263295263297
}
263296263298
]
263297-
},
263298-
"token": {
263299-
"type": "string",
263300-
"example": "\"abc\""
263301-
},
263302-
"digest": {
263303-
"type": "string",
263304-
"example": "\"sha256\""
263305263299
}
263306263300
}
263307263301
},
@@ -263424,18 +263418,10 @@
263424263418
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
263425263419
"example": "\"json\""
263426263420
},
263427-
"digest": {
263428-
"type": "string",
263429-
"example": "\"sha256\""
263430-
},
263431263421
"secret": {
263432263422
"type": "string",
263433263423
"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).",
263434263424
"example": "\"********\""
263435-
},
263436-
"token": {
263437-
"type": "string",
263438-
"example": "\"abc\""
263439263425
}
263440263426
}
263441263427
},
@@ -263801,18 +263787,10 @@
263801263787
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
263802263788
"example": "\"json\""
263803263789
},
263804-
"digest": {
263805-
"type": "string",
263806-
"example": "\"sha256\""
263807-
},
263808263790
"secret": {
263809263791
"type": "string",
263810263792
"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).",
263811263793
"example": "\"********\""
263812-
},
263813-
"token": {
263814-
"type": "string",
263815-
"example": "\"abc\""
263816263794
}
263817263795
}
263818263796
},
@@ -264169,18 +264147,10 @@
264169264147
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
264170264148
"example": "\"json\""
264171264149
},
264172-
"digest": {
264173-
"type": "string",
264174-
"example": "\"sha256\""
264175-
},
264176264150
"secret": {
264177264151
"type": "string",
264178264152
"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).",
264179264153
"example": "\"********\""
264180-
},
264181-
"token": {
264182-
"type": "string",
264183-
"example": "\"abc\""
264184264154
}
264185264155
}
264186264156
},

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

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -47425,6 +47425,16 @@ paths:
4742547425
- advisory_ghsa_id
4742647426
- advisory_summary
4742747427
- advisory_url
47428+
scope:
47429+
description: Where the dependency is utilized. `development`
47430+
means that the dependency is only utilized in the development
47431+
environment. `runtime` means that the dependency is utilized
47432+
at runtime and in the development environment.
47433+
type: string
47434+
enum:
47435+
- unknown
47436+
- runtime
47437+
- development
4742847438
required:
4742947439
- change_type
4743047440
- manifest
@@ -47435,6 +47445,7 @@ paths:
4743547445
- license
4743647446
- source_repository_url
4743747447
- vulnerabilities
47448+
- scope
4743847449
examples:
4743947450
default:
4744047451
value:
@@ -50874,13 +50885,7 @@ paths:
5087450885
url: *2
5087550886
insecure_ssl: *5
5087650887
content_type: *3
50877-
digest:
50878-
type: string
50879-
example: '"sha256"'
5088050888
secret: *4
50881-
token:
50882-
type: string
50883-
example: '"abc"'
5088450889
updated_at:
5088550890
type: string
5088650891
format: date-time
@@ -51002,12 +51007,6 @@ paths:
5100251007
content_type: *3
5100351008
secret: *4
5100451009
insecure_ssl: *5
51005-
token:
51006-
type: string
51007-
example: '"abc"'
51008-
digest:
51009-
type: string
51010-
example: '"sha256"'
5101151010
events:
5101251011
type: array
5101351012
description: Determines what [events](https://docs.github.com/webhooks/event-payloads)

‎descriptions/ghec/dereferenced/ghec.deref.json‎

Lines changed: 11 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -245996,6 +245996,15 @@
245996245996
"advisory_url"
245997245997
]
245998245998
}
245999+
},
246000+
"scope": {
246001+
"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.",
246002+
"type": "string",
246003+
"enum": [
246004+
"unknown",
246005+
"runtime",
246006+
"development"
246007+
]
245999246008
}
246000246009
},
246001246010
"required": [
@@ -246007,7 +246016,8 @@
246007246016
"package_url",
246008246017
"license",
246009246018
"source_repository_url",
246010-
"vulnerabilities"
246019+
"vulnerabilities",
246020+
"scope"
246011246021
]
246012246022
}
246013246023
},
@@ -267080,18 +267090,10 @@
267080267090
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
267081267091
"example": "\"json\""
267082267092
},
267083-
"digest": {
267084-
"type": "string",
267085-
"example": "\"sha256\""
267086-
},
267087267093
"secret": {
267088267094
"type": "string",
267089267095
"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/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).",
267090267096
"example": "\"********\""
267091-
},
267092-
"token": {
267093-
"type": "string",
267094-
"example": "\"abc\""
267095267097
}
267096267098
}
267097267099
},
@@ -267316,14 +267318,6 @@
267316267318
"type": "number"
267317267319
}
267318267320
]
267319-
},
267320-
"token": {
267321-
"type": "string",
267322-
"example": "\"abc\""
267323-
},
267324-
"digest": {
267325-
"type": "string",
267326-
"example": "\"sha256\""
267327267321
}
267328267322
}
267329267323
},
@@ -267446,18 +267440,10 @@
267446267440
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
267447267441
"example": "\"json\""
267448267442
},
267449-
"digest": {
267450-
"type": "string",
267451-
"example": "\"sha256\""
267452-
},
267453267443
"secret": {
267454267444
"type": "string",
267455267445
"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/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).",
267456267446
"example": "\"********\""
267457-
},
267458-
"token": {
267459-
"type": "string",
267460-
"example": "\"abc\""
267461267447
}
267462267448
}
267463267449
},
@@ -267823,18 +267809,10 @@
267823267809
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
267824267810
"example": "\"json\""
267825267811
},
267826-
"digest": {
267827-
"type": "string",
267828-
"example": "\"sha256\""
267829-
},
267830267812
"secret": {
267831267813
"type": "string",
267832267814
"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/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).",
267833267815
"example": "\"********\""
267834-
},
267835-
"token": {
267836-
"type": "string",
267837-
"example": "\"abc\""
267838267816
}
267839267817
}
267840267818
},
@@ -268191,18 +268169,10 @@
268191268169
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
268192268170
"example": "\"json\""
268193268171
},
268194-
"digest": {
268195-
"type": "string",
268196-
"example": "\"sha256\""
268197-
},
268198268172
"secret": {
268199268173
"type": "string",
268200268174
"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/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).",
268201268175
"example": "\"********\""
268202-
},
268203-
"token": {
268204-
"type": "string",
268205-
"example": "\"abc\""
268206268176
}
268207268177
}
268208268178
},

0 commit comments

Comments
 (0)