Skip to content

Commit c33a22c

Browse files
authored
Merge pull request #4624 from github/openapi-update-cee3dac0333232520cd13fcd6b7bd22efa0e099fa741c99f53cdb797e64052ce
Update OpenAPI 3.0 Descriptions
2 parents b7df7fa + cc301af commit c33a22c

32 files changed

+13348
-214
lines changed

descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json

Lines changed: 4698 additions & 51 deletions
Large diffs are not rendered by default.

descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml

Lines changed: 168 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111207,6 +111207,7 @@ x-webhooks:
111207111207
- push_ruleset_bypass
111208111208
- secret_scanning
111209111209
- secret_scanning_closure
111210+
- code_scanning_alert_dismissal
111210111211
exemption_request_data:
111211111212
oneOf:
111212111213
- title: Push ruleset bypass exemption request data
@@ -111300,6 +111301,25 @@ x-webhooks:
111300111301
alert_number:
111301111302
type: string
111302111303
description: The number of the alert that was detected
111304+
- title: Code scanning alert dismissal request data
111305+
description: Code scanning alerts that have dismissal requests.
111306+
type: object
111307+
properties:
111308+
type:
111309+
type: string
111310+
description: The type of request
111311+
enum:
111312+
- code_scanning_alert_dismissal
111313+
data:
111314+
type: array
111315+
description: The data related to the code scanning alerts
111316+
that have dismissal requests.
111317+
items:
111318+
type: object
111319+
properties:
111320+
alert_number:
111321+
type: string
111322+
description: The number of the alert to be dismissed
111303111323
resource_identifier:
111304111324
type: string
111305111325
description: The unique identifier for the request type of the
@@ -111322,7 +111342,7 @@ x-webhooks:
111322111342
type: object
111323111343
description: Metadata about the exemption request.
111324111344
nullable: true
111325-
oneOf:
111345+
anyOf:
111326111346
- title: Secret Scanning Push Protection Exemption Request Metadata
111327111347
description: Metadata for a secret scanning push protection
111328111348
exemption request.
@@ -111354,6 +111374,21 @@ x-webhooks:
111354111374
- false_positive
111355111375
- tests
111356111376
- revoked
111377+
- title: Code scanning alert dismissal request metadata
111378+
description: Metadata for a code scanning alert dismissal
111379+
request.
111380+
type: object
111381+
properties:
111382+
alert_title:
111383+
type: string
111384+
description: The title of the code scanning alert
111385+
reason:
111386+
type: string
111387+
description: The reason for the dismissal request
111388+
enum:
111389+
- false positive
111390+
- won't fix
111391+
- used in tests
111357111392
expires_at:
111358111393
type: string
111359111394
format: date-time
@@ -127065,6 +127100,138 @@ x-webhooks:
127065127100
- repository
127066127101
- organization
127067127102
- app
127103+
dismissal-request-code-scanning-created:
127104+
post:
127105+
summary: |-
127106+
This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
127107+
127108+
To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission.
127109+
127110+
> [!NOTE]
127111+
> Delegated alert dismissal for code scanning is currently in public preview and subject to change.
127112+
description: A code scanning alert dismissal request was created.
127113+
operationId: dismissal-request-code-scanning/created
127114+
externalDocs:
127115+
url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning
127116+
parameters:
127117+
- name: User-Agent
127118+
in: header
127119+
example: GitHub-Hookshot/123abc
127120+
schema:
127121+
type: string
127122+
- name: X-Github-Hook-Id
127123+
in: header
127124+
example: 12312312
127125+
schema:
127126+
type: string
127127+
- name: X-Github-Event
127128+
in: header
127129+
example: issues
127130+
schema:
127131+
type: string
127132+
- name: X-Github-Hook-Installation-Target-Id
127133+
in: header
127134+
example: 123123
127135+
schema:
127136+
type: string
127137+
- name: X-Github-Hook-Installation-Target-Type
127138+
in: header
127139+
example: repository
127140+
schema:
127141+
type: string
127142+
- name: X-GitHub-Delivery
127143+
in: header
127144+
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
127145+
schema:
127146+
type: string
127147+
- name: X-Hub-Signature-256
127148+
in: header
127149+
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
127150+
schema:
127151+
type: string
127152+
requestBody:
127153+
required: true
127154+
content:
127155+
application/json:
127156+
schema: *756
127157+
responses:
127158+
'200':
127159+
description: Return a 200 status to indicate that the data was received
127160+
successfully
127161+
x-github:
127162+
githubCloudOnly: true
127163+
category: webhooks
127164+
subcategory: dismissal_request_code_scanning
127165+
supported-webhook-types:
127166+
- repository
127167+
- organization
127168+
- app
127169+
dismissal-request-code-scanning-response-submitted:
127170+
post:
127171+
summary: |-
127172+
This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
127173+
127174+
To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission.
127175+
127176+
> [!NOTE]
127177+
> Delegated alert dismissal for code scanning is currently in public preview and subject to change.
127178+
description: A code scanning alert dismissal response was submitted.
127179+
operationId: dismissal-request-code-scanning/response-submitted
127180+
externalDocs:
127181+
url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning
127182+
parameters:
127183+
- name: User-Agent
127184+
in: header
127185+
example: GitHub-Hookshot/123abc
127186+
schema:
127187+
type: string
127188+
- name: X-Github-Hook-Id
127189+
in: header
127190+
example: 12312312
127191+
schema:
127192+
type: string
127193+
- name: X-Github-Event
127194+
in: header
127195+
example: issues
127196+
schema:
127197+
type: string
127198+
- name: X-Github-Hook-Installation-Target-Id
127199+
in: header
127200+
example: 123123
127201+
schema:
127202+
type: string
127203+
- name: X-Github-Hook-Installation-Target-Type
127204+
in: header
127205+
example: repository
127206+
schema:
127207+
type: string
127208+
- name: X-GitHub-Delivery
127209+
in: header
127210+
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
127211+
schema:
127212+
type: string
127213+
- name: X-Hub-Signature-256
127214+
in: header
127215+
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
127216+
schema:
127217+
type: string
127218+
requestBody:
127219+
required: true
127220+
content:
127221+
application/json:
127222+
schema: *758
127223+
responses:
127224+
'200':
127225+
description: Return a 200 status to indicate that the data was received
127226+
successfully
127227+
x-github:
127228+
githubCloudOnly: true
127229+
category: webhooks
127230+
subcategory: dismissal_request_code_scanning
127231+
supported-webhook-types:
127232+
- repository
127233+
- organization
127234+
- app
127068127235
dismissal-request-secret-scanning-cancelled:
127069127236
post:
127070127237
summary: |-

0 commit comments

Comments
 (0)