Skip to content

Commit b8260a7

Browse files
mmrobinsmmrobins
authored
Merge pull request #1577 from github/openapi-update-09fd57abae8b56c95605d79ef858fb47eae2cf5f42611e7c6ad9b26cb02360da
Update OpenAPI 3.1 Descriptions
2 parents f4fdaa4 + 7a0cef2 commit b8260a7

32 files changed

+1180
-106
lines changed

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

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44141,6 +44141,9 @@
4414144141
},
4414244142
"resolution": {
4414344143
"$ref": "#/components/schemas/secret-scanning-alert-resolution"
44144+
},
44145+
"resolution_comment": {
44146+
"$ref": "#/components/schemas/secret-scanning-alert-resolution-comment"
4414444147
}
4414544148
},
4414644149
"required": [
@@ -44174,11 +44177,14 @@
4417444177
}
4417544178
}
4417644179
},
44180+
"400": {
44181+
"description": "Bad request, resolution comment is invalid or the resolution was not changed."
44182+
},
4417744183
"404": {
4417844184
"description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found"
4417944185
},
4418044186
"422": {
44181-
"description": "State does not match the resolution"
44187+
"description": "State does not match the resolution or resolution comment"
4418244188
},
4418344189
"503": {
4418444190
"$ref": "#/components/responses/service_unavailable"
@@ -61009,6 +61015,13 @@
6100961015
],
6101061016
"format": "date-time",
6101161017
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
61018+
},
61019+
"resolution_comment": {
61020+
"type": [
61021+
"string",
61022+
"null"
61023+
],
61024+
"description": "The comment that was optionally added when this alert was closed"
6101261025
}
6101361026
}
6101461027
},
@@ -82702,9 +82715,23 @@
8270282715
],
8270382716
"format": "date-time",
8270482717
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
82718+
},
82719+
"resolution_comment": {
82720+
"type": [
82721+
"string",
82722+
"null"
82723+
],
82724+
"description": "The comment that was optionally added when this alert was closed"
8270582725
}
8270682726
}
8270782727
},
82728+
"secret-scanning-alert-resolution-comment": {
82729+
"description": "Sets an optional comment when closing an alert. Must be null when changing `state` to `open`.",
82730+
"type": [
82731+
"string",
82732+
"null"
82733+
]
82734+
},
8270882735
"secret-scanning-location-commit": {
8270982736
"description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.",
8271082737
"type": "object",
@@ -88842,7 +88869,8 @@
8884288869
"site_admin": true
8884388870
},
8884488871
"push_protection_bypassed": true,
88845-
"push_protection_bypassed_at": "2020-11-06T21:48:51Z"
88872+
"push_protection_bypassed_at": "2020-11-06T21:48:51Z",
88873+
"resolution_comment": "Example comment"
8884688874
},
8884788875
{
8884888876
"number": 1,
@@ -88926,7 +88954,8 @@
8892688954
},
8892788955
"push_protection_bypassed_by": null,
8892888956
"push_protection_bypassed": false,
88929-
"push_protection_bypassed_at": null
88957+
"push_protection_bypassed_at": null,
88958+
"resolution_comment": null
8893088959
}
8893188960
]
8893288961
},
@@ -105845,7 +105874,8 @@
105845105874
"site_admin": true
105846105875
},
105847105876
"push_protection_bypassed": true,
105848-
"push_protection_bypassed_at": "2020-11-06T21:48:51Z"
105877+
"push_protection_bypassed_at": "2020-11-06T21:48:51Z",
105878+
"resolution_comment": "Example comment"
105849105879
},
105850105880
{
105851105881
"number": 1,
@@ -105862,7 +105892,8 @@
105862105892
"secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
105863105893
"push_protection_bypassed_by": null,
105864105894
"push_protection_bypassed": false,
105865-
"push_protection_bypassed_at": null
105895+
"push_protection_bypassed_at": null,
105896+
"resolution_comment": null
105866105897
}
105867105898
]
105868105899
},
@@ -105882,7 +105913,8 @@
105882105913
"secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
105883105914
"push_protection_bypassed_by": null,
105884105915
"push_protection_bypassed": false,
105885-
"push_protection_bypassed_at": null
105916+
"push_protection_bypassed_at": null,
105917+
"resolution_comment": null
105886105918
}
105887105919
},
105888105920
"secret-scanning-alert-resolved": {
@@ -105920,7 +105952,8 @@
105920105952
"secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
105921105953
"push_protection_bypassed": false,
105922105954
"push_protection_bypassed_by": null,
105923-
"push_protection_bypassed_at": null
105955+
"push_protection_bypassed_at": null,
105956+
"resolution_comment": "Example comment"
105924105957
}
105925105958
},
105926105959
"secret-scanning-location-list": {

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

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31724,6 +31724,8 @@ paths:
3172431724
"$ref": "#/components/schemas/secret-scanning-alert-state"
3172531725
resolution:
3172631726
"$ref": "#/components/schemas/secret-scanning-alert-resolution"
31727+
resolution_comment:
31728+
"$ref": "#/components/schemas/secret-scanning-alert-resolution-comment"
3172731729
required:
3172831730
- state
3172931731
examples:
@@ -31741,11 +31743,14 @@ paths:
3174131743
examples:
3174231744
default:
3174331745
"$ref": "#/components/examples/secret-scanning-alert-resolved"
31746+
'400':
31747+
description: Bad request, resolution comment is invalid or the resolution
31748+
was not changed.
3174431749
'404':
3174531750
description: Repository is public, or secret scanning is disabled for the
3174631751
repository, or the resource is not found
3174731752
'422':
31748-
description: State does not match the resolution
31753+
description: State does not match the resolution or resolution comment
3174931754
'503':
3175031755
"$ref": "#/components/responses/service_unavailable"
3175131756
x-github:
@@ -44084,6 +44089,11 @@ components:
4408444089
format: date-time
4408544090
description: 'The time that push protection was bypassed in ISO 8601 format:
4408644091
`YYYY-MM-DDTHH:MM:SSZ`.'
44092+
resolution_comment:
44093+
type:
44094+
- string
44095+
- 'null'
44096+
description: The comment that was optionally added when this alert was closed
4408744097
advanced-security-active-committers-user:
4408844098
type: object
4408944099
properties:
@@ -59558,6 +59568,17 @@ components:
5955859568
format: date-time
5955959569
description: 'The time that push protection was bypassed in ISO 8601 format:
5956059570
`YYYY-MM-DDTHH:MM:SSZ`.'
59571+
resolution_comment:
59572+
type:
59573+
- string
59574+
- 'null'
59575+
description: The comment that was optionally added when this alert was closed
59576+
secret-scanning-alert-resolution-comment:
59577+
description: Sets an optional comment when closing an alert. Must be null when
59578+
changing `state` to `open`.
59579+
type:
59580+
- string
59581+
- 'null'
5956159582
secret-scanning-location-commit:
5956259583
description: Represents a 'commit' secret scanning location type. This location
5956359584
type shows that a secret was detected inside a commit to a repository.
@@ -64698,6 +64719,7 @@ components:
6469864719
site_admin: true
6469964720
push_protection_bypassed: true
6470064721
push_protection_bypassed_at: '2020-11-06T21:48:51Z'
64722+
resolution_comment: Example comment
6470164723
- number: 1
6470264724
created_at: '2020-11-06T18:18:30Z'
6470364725
url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1
@@ -64778,6 +64800,7 @@ components:
6477864800
push_protection_bypassed_by:
6477964801
push_protection_bypassed: false
6478064802
push_protection_bypassed_at:
64803+
resolution_comment:
6478164804
advanced-security-active-committers:
6478264805
value:
6478364806
total_advanced_security_committers: 2
@@ -79677,6 +79700,7 @@ components:
7967779700
site_admin: true
7967879701
push_protection_bypassed: true
7967979702
push_protection_bypassed_at: '2020-11-06T21:48:51Z'
79703+
resolution_comment: Example comment
7968079704
- number: 1
7968179705
created_at: '2020-11-06T18:18:30Z'
7968279706
url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1
@@ -79692,6 +79716,7 @@ components:
7969279716
push_protection_bypassed_by:
7969379717
push_protection_bypassed: false
7969479718
push_protection_bypassed_at:
79719+
resolution_comment:
7969579720
secret-scanning-alert-open:
7969679721
value:
7969779722
number: 42
@@ -79709,6 +79734,7 @@ components:
7970979734
push_protection_bypassed_by:
7971079735
push_protection_bypassed: false
7971179736
push_protection_bypassed_at:
79737+
resolution_comment:
7971279738
secret-scanning-alert-resolved:
7971379739
value:
7971479740
number: 42
@@ -79744,6 +79770,7 @@ components:
7974479770
push_protection_bypassed: false
7974579771
push_protection_bypassed_by:
7974679772
push_protection_bypassed_at:
79773+
resolution_comment: Example comment
7974779774
secret-scanning-location-list:
7974879775
value:
7974979776
- type: commit

0 commit comments

Comments
 (0)