Skip to content

Commit 7cf619b

Browse files
mmrobinsmmrobins
authored
Merge pull request #1576 from github/openapi-update-7ce36587e7b8763f4250b91da63800ca0c2f57f33996fc035aa3853cc7c8bf07
Update OpenAPI 3.0 Descriptions
2 parents b8260a7 + 8499152 commit 7cf619b

32 files changed

Lines changed: 1116 additions & 106 deletions

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

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43898,6 +43898,9 @@
4389843898
},
4389943899
"resolution": {
4390043900
"$ref": "#/components/schemas/secret-scanning-alert-resolution"
43901+
},
43902+
"resolution_comment": {
43903+
"$ref": "#/components/schemas/secret-scanning-alert-resolution-comment"
4390143904
}
4390243905
},
4390343906
"required": [
@@ -43931,11 +43934,14 @@
4393143934
}
4393243935
}
4393343936
},
43937+
"400": {
43938+
"description": "Bad request, resolution comment is invalid or the resolution was not changed."
43939+
},
4393443940
"404": {
4393543941
"description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found"
4393643942
},
4393743943
"422": {
43938-
"description": "State does not match the resolution"
43944+
"description": "State does not match the resolution or resolution comment"
4393943945
},
4394043946
"503": {
4394143947
"$ref": "#/components/responses/service_unavailable"
@@ -60153,6 +60159,11 @@
6015360159
"format": "date-time",
6015460160
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
6015560161
"nullable": true
60162+
},
60163+
"resolution_comment": {
60164+
"type": "string",
60165+
"description": "The comment that was optionally added when this alert was closed",
60166+
"nullable": true
6015660167
}
6015760168
}
6015860169
},
@@ -80355,9 +80366,19 @@
8035580366
"format": "date-time",
8035680367
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
8035780368
"nullable": true
80369+
},
80370+
"resolution_comment": {
80371+
"type": "string",
80372+
"description": "The comment that was optionally added when this alert was closed",
80373+
"nullable": true
8035880374
}
8035980375
}
8036080376
},
80377+
"secret-scanning-alert-resolution-comment": {
80378+
"description": "Sets an optional comment when closing an alert. Must be null when changing `state` to `open`.",
80379+
"type": "string",
80380+
"nullable": true
80381+
},
8036180382
"secret-scanning-location-commit": {
8036280383
"description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.",
8036380384
"type": "object",
@@ -86096,7 +86117,8 @@
8609686117
"site_admin": true
8609786118
},
8609886119
"push_protection_bypassed": true,
86099-
"push_protection_bypassed_at": "2020-11-06T21:48:51Z"
86120+
"push_protection_bypassed_at": "2020-11-06T21:48:51Z",
86121+
"resolution_comment": "Example comment"
8610086122
},
8610186123
{
8610286124
"number": 1,
@@ -86180,7 +86202,8 @@
8618086202
},
8618186203
"push_protection_bypassed_by": null,
8618286204
"push_protection_bypassed": false,
86183-
"push_protection_bypassed_at": null
86205+
"push_protection_bypassed_at": null,
86206+
"resolution_comment": null
8618486207
}
8618586208
]
8618686209
},
@@ -103099,7 +103122,8 @@
103099103122
"site_admin": true
103100103123
},
103101103124
"push_protection_bypassed": true,
103102-
"push_protection_bypassed_at": "2020-11-06T21:48:51Z"
103125+
"push_protection_bypassed_at": "2020-11-06T21:48:51Z",
103126+
"resolution_comment": "Example comment"
103103103127
},
103104103128
{
103105103129
"number": 1,
@@ -103116,7 +103140,8 @@
103116103140
"secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
103117103141
"push_protection_bypassed_by": null,
103118103142
"push_protection_bypassed": false,
103119-
"push_protection_bypassed_at": null
103143+
"push_protection_bypassed_at": null,
103144+
"resolution_comment": null
103120103145
}
103121103146
]
103122103147
},
@@ -103136,7 +103161,8 @@
103136103161
"secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
103137103162
"push_protection_bypassed_by": null,
103138103163
"push_protection_bypassed": false,
103139-
"push_protection_bypassed_at": null
103164+
"push_protection_bypassed_at": null,
103165+
"resolution_comment": null
103140103166
}
103141103167
},
103142103168
"secret-scanning-alert-resolved": {
@@ -103174,7 +103200,8 @@
103174103200
"secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
103175103201
"push_protection_bypassed": false,
103176103202
"push_protection_bypassed_by": null,
103177-
"push_protection_bypassed_at": null
103203+
"push_protection_bypassed_at": null,
103204+
"resolution_comment": "Example comment"
103178103205
}
103179103206
},
103180103207
"secret-scanning-location-list": {

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

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31602,6 +31602,8 @@ paths:
3160231602
"$ref": "#/components/schemas/secret-scanning-alert-state"
3160331603
resolution:
3160431604
"$ref": "#/components/schemas/secret-scanning-alert-resolution"
31605+
resolution_comment:
31606+
"$ref": "#/components/schemas/secret-scanning-alert-resolution-comment"
3160531607
required:
3160631608
- state
3160731609
examples:
@@ -31619,11 +31621,14 @@ paths:
3161931621
examples:
3162031622
default:
3162131623
"$ref": "#/components/examples/secret-scanning-alert-resolved"
31624+
'400':
31625+
description: Bad request, resolution comment is invalid or the resolution
31626+
was not changed.
3162231627
'404':
3162331628
description: Repository is public, or secret scanning is disabled for the
3162431629
repository, or the resource is not found
3162531630
'422':
31626-
description: State does not match the resolution
31631+
description: State does not match the resolution or resolution comment
3162731632
'503':
3162831633
"$ref": "#/components/responses/service_unavailable"
3162931634
x-github:
@@ -43710,6 +43715,10 @@ components:
4371043715
description: 'The time that push protection was bypassed in ISO 8601 format:
4371143716
`YYYY-MM-DDTHH:MM:SSZ`.'
4371243717
nullable: true
43718+
resolution_comment:
43719+
type: string
43720+
description: The comment that was optionally added when this alert was closed
43721+
nullable: true
4371343722
advanced-security-active-committers-user:
4371443723
type: object
4371543724
properties:
@@ -59234,6 +59243,15 @@ components:
5923459243
description: 'The time that push protection was bypassed in ISO 8601 format:
5923559244
`YYYY-MM-DDTHH:MM:SSZ`.'
5923659245
nullable: true
59246+
resolution_comment:
59247+
type: string
59248+
description: The comment that was optionally added when this alert was closed
59249+
nullable: true
59250+
secret-scanning-alert-resolution-comment:
59251+
description: Sets an optional comment when closing an alert. Must be null when
59252+
changing `state` to `open`.
59253+
type: string
59254+
nullable: true
5923759255
secret-scanning-location-commit:
5923859256
description: Represents a 'commit' secret scanning location type. This location
5923959257
type shows that a secret was detected inside a commit to a repository.
@@ -64191,6 +64209,7 @@ components:
6419164209
site_admin: true
6419264210
push_protection_bypassed: true
6419364211
push_protection_bypassed_at: '2020-11-06T21:48:51Z'
64212+
resolution_comment: Example comment
6419464213
- number: 1
6419564214
created_at: '2020-11-06T18:18:30Z'
6419664215
url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1
@@ -64271,6 +64290,7 @@ components:
6427164290
push_protection_bypassed_by:
6427264291
push_protection_bypassed: false
6427364292
push_protection_bypassed_at:
64293+
resolution_comment:
6427464294
advanced-security-active-committers:
6427564295
value:
6427664296
total_advanced_security_committers: 2
@@ -79170,6 +79190,7 @@ components:
7917079190
site_admin: true
7917179191
push_protection_bypassed: true
7917279192
push_protection_bypassed_at: '2020-11-06T21:48:51Z'
79193+
resolution_comment: Example comment
7917379194
- number: 1
7917479195
created_at: '2020-11-06T18:18:30Z'
7917579196
url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1
@@ -79185,6 +79206,7 @@ components:
7918579206
push_protection_bypassed_by:
7918679207
push_protection_bypassed: false
7918779208
push_protection_bypassed_at:
79209+
resolution_comment:
7918879210
secret-scanning-alert-open:
7918979211
value:
7919079212
number: 42
@@ -79202,6 +79224,7 @@ components:
7920279224
push_protection_bypassed_by:
7920379225
push_protection_bypassed: false
7920479226
push_protection_bypassed_at:
79227+
resolution_comment:
7920579228
secret-scanning-alert-resolved:
7920679229
value:
7920779230
number: 42
@@ -79237,6 +79260,7 @@ components:
7923779260
push_protection_bypassed: false
7923879261
push_protection_bypassed_by:
7923979262
push_protection_bypassed_at:
79263+
resolution_comment: Example comment
7924079264
secret-scanning-location-list:
7924179265
value:
7924279266
- type: commit

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

Lines changed: 50 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20555,6 +20555,11 @@
2055520555
"format": "date-time",
2055620556
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
2055720557
"nullable": true
20558+
},
20559+
"resolution_comment": {
20560+
"type": "string",
20561+
"description": "The comment that was optionally added when this alert was closed",
20562+
"nullable": true
2055820563
}
2055920564
}
2056020565
}
@@ -20682,7 +20687,8 @@
2068220687
"site_admin": true
2068320688
},
2068420689
"push_protection_bypassed": true,
20685-
"push_protection_bypassed_at": "2020-11-06T21:48:51Z"
20690+
"push_protection_bypassed_at": "2020-11-06T21:48:51Z",
20691+
"resolution_comment": "Example comment"
2068620692
},
2068720693
{
2068820694
"number": 1,
@@ -20766,7 +20772,8 @@
2076620772
},
2076720773
"push_protection_bypassed_by": null,
2076820774
"push_protection_bypassed": false,
20769-
"push_protection_bypassed_at": null
20775+
"push_protection_bypassed_at": null,
20776+
"resolution_comment": null
2077020777
}
2077120778
]
2077220779
}
@@ -109467,6 +109474,11 @@
109467109474
"format": "date-time",
109468109475
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
109469109476
"nullable": true
109477+
},
109478+
"resolution_comment": {
109479+
"type": "string",
109480+
"description": "The comment that was optionally added when this alert was closed",
109481+
"nullable": true
109470109482
}
109471109483
}
109472109484
}
@@ -109594,7 +109606,8 @@
109594109606
"site_admin": true
109595109607
},
109596109608
"push_protection_bypassed": true,
109597-
"push_protection_bypassed_at": "2020-11-06T21:48:51Z"
109609+
"push_protection_bypassed_at": "2020-11-06T21:48:51Z",
109610+
"resolution_comment": "Example comment"
109598109611
},
109599109612
{
109600109613
"number": 1,
@@ -109678,7 +109691,8 @@
109678109691
},
109679109692
"push_protection_bypassed_by": null,
109680109693
"push_protection_bypassed": false,
109681-
"push_protection_bypassed_at": null
109694+
"push_protection_bypassed_at": null,
109695+
"resolution_comment": null
109682109696
}
109683109697
]
109684109698
}
@@ -381671,6 +381685,11 @@
381671381685
"format": "date-time",
381672381686
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
381673381687
"nullable": true
381688+
},
381689+
"resolution_comment": {
381690+
"type": "string",
381691+
"description": "The comment that was optionally added when this alert was closed",
381692+
"nullable": true
381674381693
}
381675381694
}
381676381695
}
@@ -381731,7 +381750,8 @@
381731381750
"site_admin": true
381732381751
},
381733381752
"push_protection_bypassed": true,
381734-
"push_protection_bypassed_at": "2020-11-06T21:48:51Z"
381753+
"push_protection_bypassed_at": "2020-11-06T21:48:51Z",
381754+
"resolution_comment": "Example comment"
381735381755
},
381736381756
{
381737381757
"number": 1,
@@ -381748,7 +381768,8 @@
381748381768
"secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
381749381769
"push_protection_bypassed_by": null,
381750381770
"push_protection_bypassed": false,
381751-
"push_protection_bypassed_at": null
381771+
"push_protection_bypassed_at": null,
381772+
"resolution_comment": null
381752381773
}
381753381774
]
381754381775
}
@@ -382162,6 +382183,11 @@
382162382183
"format": "date-time",
382163382184
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
382164382185
"nullable": true
382186+
},
382187+
"resolution_comment": {
382188+
"type": "string",
382189+
"description": "The comment that was optionally added when this alert was closed",
382190+
"nullable": true
382165382191
}
382166382192
}
382167382193
},
@@ -382182,7 +382208,8 @@
382182382208
"secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
382183382209
"push_protection_bypassed_by": null,
382184382210
"push_protection_bypassed": false,
382185-
"push_protection_bypassed_at": null
382211+
"push_protection_bypassed_at": null,
382212+
"resolution_comment": null
382186382213
}
382187382214
}
382188382215
}
@@ -382292,6 +382319,11 @@
382292382319
"revoked",
382293382320
"used_in_tests"
382294382321
]
382322+
},
382323+
"resolution_comment": {
382324+
"description": "Sets an optional comment when closing an alert. Must be null when changing `state` to `open`.",
382325+
"type": "string",
382326+
"nullable": true
382295382327
}
382296382328
},
382297382329
"required": [
@@ -382639,6 +382671,11 @@
382639382671
"format": "date-time",
382640382672
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
382641382673
"nullable": true
382674+
},
382675+
"resolution_comment": {
382676+
"type": "string",
382677+
"description": "The comment that was optionally added when this alert was closed",
382678+
"nullable": true
382642382679
}
382643382680
}
382644382681
},
@@ -382678,18 +382715,22 @@
382678382715
"secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
382679382716
"push_protection_bypassed": false,
382680382717
"push_protection_bypassed_by": null,
382681-
"push_protection_bypassed_at": null
382718+
"push_protection_bypassed_at": null,
382719+
"resolution_comment": "Example comment"
382682382720
}
382683382721
}
382684382722
}
382685382723
}
382686382724
}
382687382725
},
382726+
"400": {
382727+
"description": "Bad request, resolution comment is invalid or the resolution was not changed."
382728+
},
382688382729
"404": {
382689382730
"description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found"
382690382731
},
382691382732
"422": {
382692-
"description": "State does not match the resolution"
382733+
"description": "State does not match the resolution or resolution comment"
382693382734
},
382694382735
"503": {
382695382736
"description": "Service unavailable",

0 commit comments

Comments
 (0)