Skip to content

Commit 6c5ed6f

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #1683 from github/openapi-update-20f3942ba6eeab03097b44d4550afd30b243a70d7306f087033ee0d140207e14
Update OpenAPI 3.0 Descriptions
2 parents a40f75f + e7bf18f commit 6c5ed6f

12 files changed

Lines changed: 84 additions & 87 deletions

File tree

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81581,6 +81581,11 @@
8158181581
"resolved_by": {
8158281582
"$ref": "#/components/schemas/nullable-simple-user"
8158381583
},
81584+
"resolution_comment": {
81585+
"type": "string",
81586+
"description": "An optional comment to resolve an alert.",
81587+
"nullable": true
81588+
},
8158481589
"secret_type": {
8158581590
"type": "string",
8158681591
"description": "The type of secret that secret scanning detected."
@@ -81606,11 +81611,6 @@
8160681611
"format": "date-time",
8160781612
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
8160881613
"nullable": true
81609-
},
81610-
"resolution_comment": {
81611-
"type": "string",
81612-
"description": "The comment that was optionally added when this alert was closed",
81613-
"nullable": true
8161481614
}
8161581615
}
8161681616
},

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60135,6 +60135,10 @@ components:
6013560135
nullable: true
6013660136
resolved_by:
6013760137
"$ref": "#/components/schemas/nullable-simple-user"
60138+
resolution_comment:
60139+
type: string
60140+
description: An optional comment to resolve an alert.
60141+
nullable: true
6013860142
secret_type:
6013960143
type: string
6014060144
description: The type of secret that secret scanning detected.
@@ -60158,10 +60162,6 @@ components:
6015860162
description: 'The time that push protection was bypassed in ISO 8601 format:
6015960163
`YYYY-MM-DDTHH:MM:SSZ`.'
6016060164
nullable: true
60161-
resolution_comment:
60162-
type: string
60163-
description: The comment that was optionally added when this alert was closed
60164-
nullable: true
6016560165
secret-scanning-alert-resolution-comment:
6016660166
description: An optional comment when closing an alert. Cannot be updated or
6016760167
deleted. Must be `null` when changing `state` to `open`.

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -344180,6 +344180,11 @@
344180344180
],
344181344181
"nullable": true
344182344182
},
344183+
"resolution_comment": {
344184+
"type": "string",
344185+
"description": "An optional comment to resolve an alert.",
344186+
"nullable": true
344187+
},
344183344188
"secret_type": {
344184344189
"type": "string",
344185344190
"description": "The type of secret that secret scanning detected."
@@ -344322,11 +344327,6 @@
344322344327
"format": "date-time",
344323344328
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
344324344329
"nullable": true
344325-
},
344326-
"resolution_comment": {
344327-
"type": "string",
344328-
"description": "The comment that was optionally added when this alert was closed",
344329-
"nullable": true
344330344330
}
344331344331
}
344332344332
}
@@ -344678,6 +344678,11 @@
344678344678
],
344679344679
"nullable": true
344680344680
},
344681+
"resolution_comment": {
344682+
"type": "string",
344683+
"description": "An optional comment to resolve an alert.",
344684+
"nullable": true
344685+
},
344681344686
"secret_type": {
344682344687
"type": "string",
344683344688
"description": "The type of secret that secret scanning detected."
@@ -344820,11 +344825,6 @@
344820344825
"format": "date-time",
344821344826
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
344822344827
"nullable": true
344823-
},
344824-
"resolution_comment": {
344825-
"type": "string",
344826-
"description": "The comment that was optionally added when this alert was closed",
344827-
"nullable": true
344828344828
}
344829344829
}
344830344830
},
@@ -345166,6 +345166,11 @@
345166345166
],
345167345167
"nullable": true
345168345168
},
345169+
"resolution_comment": {
345170+
"type": "string",
345171+
"description": "An optional comment to resolve an alert.",
345172+
"nullable": true
345173+
},
345169345174
"secret_type": {
345170345175
"type": "string",
345171345176
"description": "The type of secret that secret scanning detected."
@@ -345308,11 +345313,6 @@
345308345313
"format": "date-time",
345309345314
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
345310345315
"nullable": true
345311-
},
345312-
"resolution_comment": {
345313-
"type": "string",
345314-
"description": "The comment that was optionally added when this alert was closed",
345315-
"nullable": true
345316345316
}
345317345317
}
345318345318
},

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66776,6 +66776,10 @@ paths:
6677666776
properties: *13
6677766777
required: *14
6677866778
nullable: true
66779+
resolution_comment:
66780+
type: string
66781+
description: An optional comment to resolve an alert.
66782+
nullable: true
6677966783
secret_type:
6678066784
type: string
6678166785
description: The type of secret that secret scanning detected.
@@ -66805,11 +66809,6 @@ paths:
6680566809
description: 'The time that push protection was bypassed in
6680666810
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
6680766811
nullable: true
66808-
resolution_comment:
66809-
type: string
66810-
description: The comment that was optionally added when this
66811-
alert was closed
66812-
nullable: true
6681366812
examples:
6681466813
default:
6681566814
value:

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -347527,6 +347527,11 @@
347527347527
],
347528347528
"nullable": true
347529347529
},
347530+
"resolution_comment": {
347531+
"type": "string",
347532+
"description": "An optional comment to resolve an alert.",
347533+
"nullable": true
347534+
},
347530347535
"secret_type": {
347531347536
"type": "string",
347532347537
"description": "The type of secret that secret scanning detected."
@@ -347669,11 +347674,6 @@
347669347674
"format": "date-time",
347670347675
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
347671347676
"nullable": true
347672-
},
347673-
"resolution_comment": {
347674-
"type": "string",
347675-
"description": "The comment that was optionally added when this alert was closed",
347676-
"nullable": true
347677347677
}
347678347678
}
347679347679
}
@@ -348025,6 +348025,11 @@
348025348025
],
348026348026
"nullable": true
348027348027
},
348028+
"resolution_comment": {
348029+
"type": "string",
348030+
"description": "An optional comment to resolve an alert.",
348031+
"nullable": true
348032+
},
348028348033
"secret_type": {
348029348034
"type": "string",
348030348035
"description": "The type of secret that secret scanning detected."
@@ -348167,11 +348172,6 @@
348167348172
"format": "date-time",
348168348173
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
348169348174
"nullable": true
348170-
},
348171-
"resolution_comment": {
348172-
"type": "string",
348173-
"description": "The comment that was optionally added when this alert was closed",
348174-
"nullable": true
348175348175
}
348176348176
}
348177348177
},
@@ -348513,6 +348513,11 @@
348513348513
],
348514348514
"nullable": true
348515348515
},
348516+
"resolution_comment": {
348517+
"type": "string",
348518+
"description": "An optional comment to resolve an alert.",
348519+
"nullable": true
348520+
},
348516348521
"secret_type": {
348517348522
"type": "string",
348518348523
"description": "The type of secret that secret scanning detected."
@@ -348655,11 +348660,6 @@
348655348660
"format": "date-time",
348656348661
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
348657348662
"nullable": true
348658-
},
348659-
"resolution_comment": {
348660-
"type": "string",
348661-
"description": "The comment that was optionally added when this alert was closed",
348662-
"nullable": true
348663348663
}
348664348664
}
348665348665
},

‎descriptions/ghec/dereferenced/ghec.deref.yaml‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68277,6 +68277,10 @@ paths:
6827768277
properties: *13
6827868278
required: *14
6827968279
nullable: true
68280+
resolution_comment:
68281+
type: string
68282+
description: An optional comment to resolve an alert.
68283+
nullable: true
6828068284
secret_type:
6828168285
type: string
6828268286
description: The type of secret that secret scanning detected.
@@ -68306,11 +68310,6 @@ paths:
6830668310
description: 'The time that push protection was bypassed in
6830768311
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
6830868312
nullable: true
68309-
resolution_comment:
68310-
type: string
68311-
description: The comment that was optionally added when this
68312-
alert was closed
68313-
nullable: true
6831468313
examples:
6831568314
default:
6831668315
value:

‎descriptions/ghec/ghec.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84286,6 +84286,11 @@
8428684286
"resolved_by": {
8428784287
"$ref": "#/components/schemas/nullable-simple-user"
8428884288
},
84289+
"resolution_comment": {
84290+
"type": "string",
84291+
"description": "An optional comment to resolve an alert.",
84292+
"nullable": true
84293+
},
8428984294
"secret_type": {
8429084295
"type": "string",
8429184296
"description": "The type of secret that secret scanning detected."
@@ -84311,11 +84316,6 @@
8431184316
"format": "date-time",
8431284317
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
8431384318
"nullable": true
84314-
},
84315-
"resolution_comment": {
84316-
"type": "string",
84317-
"description": "The comment that was optionally added when this alert was closed",
84318-
"nullable": true
8431984319
}
8432084320
}
8432184321
},

‎descriptions/ghec/ghec.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62083,6 +62083,10 @@ components:
6208362083
nullable: true
6208462084
resolved_by:
6208562085
"$ref": "#/components/schemas/nullable-simple-user"
62086+
resolution_comment:
62087+
type: string
62088+
description: An optional comment to resolve an alert.
62089+
nullable: true
6208662090
secret_type:
6208762091
type: string
6208862092
description: The type of secret that secret scanning detected.
@@ -62106,10 +62110,6 @@ components:
6210662110
description: 'The time that push protection was bypassed in ISO 8601 format:
6210762111
`YYYY-MM-DDTHH:MM:SSZ`.'
6210862112
nullable: true
62109-
resolution_comment:
62110-
type: string
62111-
description: The comment that was optionally added when this alert was closed
62112-
nullable: true
6211362113
secret-scanning-alert-resolution-comment:
6211462114
description: An optional comment when closing an alert. Cannot be updated or
6211562115
deleted. Must be `null` when changing `state` to `open`.

‎descriptions/github.ae/dereferenced/github.ae.deref.json‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -285082,18 +285082,18 @@
285082285082
],
285083285083
"nullable": true
285084285084
},
285085+
"resolution_comment": {
285086+
"type": "string",
285087+
"description": "An optional comment to resolve an alert.",
285088+
"nullable": true
285089+
},
285085285090
"secret_type": {
285086285091
"type": "string",
285087285092
"description": "The type of secret that secret scanning detected."
285088285093
},
285089285094
"secret": {
285090285095
"type": "string",
285091285096
"description": "The secret that was detected."
285092-
},
285093-
"resolution_comment": {
285094-
"type": "string",
285095-
"description": "The comment that was optionally added when this alert was closed",
285096-
"nullable": true
285097285097
}
285098285098
}
285099285099
}
@@ -285414,18 +285414,18 @@
285414285414
],
285415285415
"nullable": true
285416285416
},
285417+
"resolution_comment": {
285418+
"type": "string",
285419+
"description": "An optional comment to resolve an alert.",
285420+
"nullable": true
285421+
},
285417285422
"secret_type": {
285418285423
"type": "string",
285419285424
"description": "The type of secret that secret scanning detected."
285420285425
},
285421285426
"secret": {
285422285427
"type": "string",
285423285428
"description": "The secret that was detected."
285424-
},
285425-
"resolution_comment": {
285426-
"type": "string",
285427-
"description": "The comment that was optionally added when this alert was closed",
285428-
"nullable": true
285429285429
}
285430285430
}
285431285431
},
@@ -285759,18 +285759,18 @@
285759285759
],
285760285760
"nullable": true
285761285761
},
285762+
"resolution_comment": {
285763+
"type": "string",
285764+
"description": "An optional comment to resolve an alert.",
285765+
"nullable": true
285766+
},
285762285767
"secret_type": {
285763285768
"type": "string",
285764285769
"description": "The type of secret that secret scanning detected."
285765285770
},
285766285771
"secret": {
285767285772
"type": "string",
285768285773
"description": "The secret that was detected."
285769-
},
285770-
"resolution_comment": {
285771-
"type": "string",
285772-
"description": "The comment that was optionally added when this alert was closed",
285773-
"nullable": true
285774285774
}
285775285775
}
285776285776
},

‎descriptions/github.ae/dereferenced/github.ae.deref.yaml‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55527,17 +55527,16 @@ paths:
5552755527
properties: *12
5552855528
required: *13
5552955529
nullable: true
55530+
resolution_comment:
55531+
type: string
55532+
description: An optional comment to resolve an alert.
55533+
nullable: true
5553055534
secret_type:
5553155535
type: string
5553255536
description: The type of secret that secret scanning detected.
5553355537
secret:
5553455538
type: string
5553555539
description: The secret that was detected.
55536-
resolution_comment:
55537-
type: string
55538-
description: The comment that was optionally added when this
55539-
alert was closed
55540-
nullable: true
5554155540
examples:
5554255541
default:
5554355542
value:

0 commit comments

Comments
 (0)