Skip to content

Commit 7448095

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #1684 from github/openapi-update-b2a1905ea70d88d939f1568d20142cde6bbc0ad0349f2c513eea0ef7c4012c2c
Update OpenAPI 3.1 Descriptions
2 parents 6c5ed6f + ba37d71 commit 7448095

12 files changed

Lines changed: 114 additions & 117 deletions

File tree

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83946,6 +83946,13 @@
8394683946
}
8394783947
]
8394883948
},
83949+
"resolution_comment": {
83950+
"type": [
83951+
"string",
83952+
"null"
83953+
],
83954+
"description": "An optional comment to resolve an alert."
83955+
},
8394983956
"secret_type": {
8395083957
"type": "string",
8395183958
"description": "The type of secret that secret scanning detected."
@@ -83982,13 +83989,6 @@
8398283989
],
8398383990
"format": "date-time",
8398483991
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
83985-
},
83986-
"resolution_comment": {
83987-
"type": [
83988-
"string",
83989-
"null"
83990-
],
83991-
"description": "The comment that was optionally added when this alert was closed"
8399283992
}
8399383993
}
8399483994
},

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60471,6 +60471,11 @@ components:
6047160471
anyOf:
6047260472
- type: 'null'
6047360473
- "$ref": "#/components/schemas/simple-user"
60474+
resolution_comment:
60475+
type:
60476+
- string
60477+
- 'null'
60478+
description: An optional comment to resolve an alert.
6047460479
secret_type:
6047560480
type: string
6047660481
description: The type of secret that secret scanning detected.
@@ -60498,11 +60503,6 @@ components:
6049860503
format: date-time
6049960504
description: 'The time that push protection was bypassed in ISO 8601 format:
6050060505
`YYYY-MM-DDTHH:MM:SSZ`.'
60501-
resolution_comment:
60502-
type:
60503-
- string
60504-
- 'null'
60505-
description: The comment that was optionally added when this alert was closed
6050660506
secret-scanning-alert-resolution-comment:
6050760507
description: An optional comment when closing an alert. Cannot be updated or
6050860508
deleted. Must be `null` when changing `state` to `open`.

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

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -408090,6 +408090,13 @@
408090408090
}
408091408091
]
408092408092
},
408093+
"resolution_comment": {
408094+
"type": [
408095+
"string",
408096+
"null"
408097+
],
408098+
"description": "An optional comment to resolve an alert."
408099+
},
408093408100
"secret_type": {
408094408101
"type": "string",
408095408102
"description": "The type of secret that secret scanning detected."
@@ -408284,13 +408291,6 @@
408284408291
],
408285408292
"format": "date-time",
408286408293
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
408287-
},
408288-
"resolution_comment": {
408289-
"type": [
408290-
"string",
408291-
"null"
408292-
],
408293-
"description": "The comment that was optionally added when this alert was closed"
408294408294
}
408295408295
}
408296408296
}
@@ -408694,6 +408694,13 @@
408694408694
}
408695408695
]
408696408696
},
408697+
"resolution_comment": {
408698+
"type": [
408699+
"string",
408700+
"null"
408701+
],
408702+
"description": "An optional comment to resolve an alert."
408703+
},
408697408704
"secret_type": {
408698408705
"type": "string",
408699408706
"description": "The type of secret that secret scanning detected."
@@ -408888,13 +408895,6 @@
408888408895
],
408889408896
"format": "date-time",
408890408897
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
408891-
},
408892-
"resolution_comment": {
408893-
"type": [
408894-
"string",
408895-
"null"
408896-
],
408897-
"description": "The comment that was optionally added when this alert was closed"
408898408898
}
408899408899
}
408900408900
},
@@ -409292,6 +409292,13 @@
409292409292
}
409293409293
]
409294409294
},
409295+
"resolution_comment": {
409296+
"type": [
409297+
"string",
409298+
"null"
409299+
],
409300+
"description": "An optional comment to resolve an alert."
409301+
},
409295409302
"secret_type": {
409296409303
"type": "string",
409297409304
"description": "The type of secret that secret scanning detected."
@@ -409486,13 +409493,6 @@
409486409493
],
409487409494
"format": "date-time",
409488409495
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
409489-
},
409490-
"resolution_comment": {
409491-
"type": [
409492-
"string",
409493-
"null"
409494-
],
409495-
"description": "The comment that was optionally added when this alert was closed"
409496409496
}
409497409497
}
409498409498
},

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68318,6 +68318,11 @@ paths:
6831868318
anyOf:
6831968319
- type: 'null'
6832068320
- *13
68321+
resolution_comment:
68322+
type:
68323+
- string
68324+
- 'null'
68325+
description: An optional comment to resolve an alert.
6832168326
secret_type:
6832268327
type: string
6832368328
description: The type of secret that secret scanning detected.
@@ -68346,12 +68351,6 @@ paths:
6834668351
format: date-time
6834768352
description: 'The time that push protection was bypassed in
6834868353
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
68349-
resolution_comment:
68350-
type:
68351-
- string
68352-
- 'null'
68353-
description: The comment that was optionally added when this
68354-
alert was closed
6835568354
examples:
6835668355
default:
6835768356
value:

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

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -411583,6 +411583,13 @@
411583411583
}
411584411584
]
411585411585
},
411586+
"resolution_comment": {
411587+
"type": [
411588+
"string",
411589+
"null"
411590+
],
411591+
"description": "An optional comment to resolve an alert."
411592+
},
411586411593
"secret_type": {
411587411594
"type": "string",
411588411595
"description": "The type of secret that secret scanning detected."
@@ -411777,13 +411784,6 @@
411777411784
],
411778411785
"format": "date-time",
411779411786
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
411780-
},
411781-
"resolution_comment": {
411782-
"type": [
411783-
"string",
411784-
"null"
411785-
],
411786-
"description": "The comment that was optionally added when this alert was closed"
411787411787
}
411788411788
}
411789411789
}
@@ -412187,6 +412187,13 @@
412187412187
}
412188412188
]
412189412189
},
412190+
"resolution_comment": {
412191+
"type": [
412192+
"string",
412193+
"null"
412194+
],
412195+
"description": "An optional comment to resolve an alert."
412196+
},
412190412197
"secret_type": {
412191412198
"type": "string",
412192412199
"description": "The type of secret that secret scanning detected."
@@ -412381,13 +412388,6 @@
412381412388
],
412382412389
"format": "date-time",
412383412390
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
412384-
},
412385-
"resolution_comment": {
412386-
"type": [
412387-
"string",
412388-
"null"
412389-
],
412390-
"description": "The comment that was optionally added when this alert was closed"
412391412391
}
412392412392
}
412393412393
},
@@ -412785,6 +412785,13 @@
412785412785
}
412786412786
]
412787412787
},
412788+
"resolution_comment": {
412789+
"type": [
412790+
"string",
412791+
"null"
412792+
],
412793+
"description": "An optional comment to resolve an alert."
412794+
},
412788412795
"secret_type": {
412789412796
"type": "string",
412790412797
"description": "The type of secret that secret scanning detected."
@@ -412979,13 +412986,6 @@
412979412986
],
412980412987
"format": "date-time",
412981412988
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
412982-
},
412983-
"resolution_comment": {
412984-
"type": [
412985-
"string",
412986-
"null"
412987-
],
412988-
"description": "The comment that was optionally added when this alert was closed"
412989412989
}
412990412990
}
412991412991
},

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69860,6 +69860,11 @@ paths:
6986069860
anyOf:
6986169861
- type: 'null'
6986269862
- *13
69863+
resolution_comment:
69864+
type:
69865+
- string
69866+
- 'null'
69867+
description: An optional comment to resolve an alert.
6986369868
secret_type:
6986469869
type: string
6986569870
description: The type of secret that secret scanning detected.
@@ -69888,12 +69893,6 @@ paths:
6988869893
format: date-time
6988969894
description: 'The time that push protection was bypassed in
6989069895
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
69891-
resolution_comment:
69892-
type:
69893-
- string
69894-
- 'null'
69895-
description: The comment that was optionally added when this
69896-
alert was closed
6989769896
examples:
6989869897
default:
6989969898
value:

‎descriptions-next/ghec/ghec.json‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86759,6 +86759,13 @@
8675986759
}
8676086760
]
8676186761
},
86762+
"resolution_comment": {
86763+
"type": [
86764+
"string",
86765+
"null"
86766+
],
86767+
"description": "An optional comment to resolve an alert."
86768+
},
8676286769
"secret_type": {
8676386770
"type": "string",
8676486771
"description": "The type of secret that secret scanning detected."
@@ -86795,13 +86802,6 @@
8679586802
],
8679686803
"format": "date-time",
8679786804
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
86798-
},
86799-
"resolution_comment": {
86800-
"type": [
86801-
"string",
86802-
"null"
86803-
],
86804-
"description": "The comment that was optionally added when this alert was closed"
8680586805
}
8680686806
}
8680786807
},

‎descriptions-next/ghec/ghec.yaml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62473,6 +62473,11 @@ components:
6247362473
anyOf:
6247462474
- type: 'null'
6247562475
- "$ref": "#/components/schemas/simple-user"
62476+
resolution_comment:
62477+
type:
62478+
- string
62479+
- 'null'
62480+
description: An optional comment to resolve an alert.
6247662481
secret_type:
6247762482
type: string
6247862483
description: The type of secret that secret scanning detected.
@@ -62500,11 +62505,6 @@ components:
6250062505
format: date-time
6250162506
description: 'The time that push protection was bypassed in ISO 8601 format:
6250262507
`YYYY-MM-DDTHH:MM:SSZ`.'
62503-
resolution_comment:
62504-
type:
62505-
- string
62506-
- 'null'
62507-
description: The comment that was optionally added when this alert was closed
6250862508
secret-scanning-alert-resolution-comment:
6250962509
description: An optional comment when closing an alert. Cannot be updated or
6251062510
deleted. Must be `null` when changing `state` to `open`.

0 commit comments

Comments
 (0)