Skip to content

Commit ef11ae6

Browse files
authored
Merge pull request #4625 from github/openapi-update-01593fc2cda020664e118e43acd18681a81abff5b6c70a6b5060502805832aa2
Update OpenAPI 3.1 Descriptions
2 parents c33a22c + e8d0be3 commit ef11ae6

32 files changed

Lines changed: 14876 additions & 210 deletions

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

Lines changed: 5462 additions & 49 deletions
Large diffs are not rendered by default.

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

Lines changed: 168 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113676,6 +113676,7 @@ webhooks:
113676113676
- push_ruleset_bypass
113677113677
- secret_scanning
113678113678
- secret_scanning_closure
113679+
- code_scanning_alert_dismissal
113679113680
exemption_request_data:
113680113681
oneOf:
113681113682
- title: Push ruleset bypass exemption request data
@@ -113769,6 +113770,25 @@ webhooks:
113769113770
alert_number:
113770113771
type: string
113771113772
description: The number of the alert that was detected
113773+
- title: Code scanning alert dismissal request data
113774+
description: Code scanning alerts that have dismissal requests.
113775+
type: object
113776+
properties:
113777+
type:
113778+
type: string
113779+
description: The type of request
113780+
enum:
113781+
- code_scanning_alert_dismissal
113782+
data:
113783+
type: array
113784+
description: The data related to the code scanning alerts
113785+
that have dismissal requests.
113786+
items:
113787+
type: object
113788+
properties:
113789+
alert_number:
113790+
type: string
113791+
description: The number of the alert to be dismissed
113772113792
resource_identifier:
113773113793
type: string
113774113794
description: The unique identifier for the request type of the
@@ -113794,7 +113814,7 @@ webhooks:
113794113814
- object
113795113815
- 'null'
113796113816
description: Metadata about the exemption request.
113797-
oneOf:
113817+
anyOf:
113798113818
- title: Secret Scanning Push Protection Exemption Request Metadata
113799113819
description: Metadata for a secret scanning push protection
113800113820
exemption request.
@@ -113826,6 +113846,21 @@ webhooks:
113826113846
- false_positive
113827113847
- tests
113828113848
- revoked
113849+
- title: Code scanning alert dismissal request metadata
113850+
description: Metadata for a code scanning alert dismissal
113851+
request.
113852+
type: object
113853+
properties:
113854+
alert_title:
113855+
type: string
113856+
description: The title of the code scanning alert
113857+
reason:
113858+
type: string
113859+
description: The reason for the dismissal request
113860+
enum:
113861+
- false positive
113862+
- won't fix
113863+
- used in tests
113829113864
expires_at:
113830113865
type: string
113831113866
format: date-time
@@ -129822,6 +129857,138 @@ webhooks:
129822129857
- repository
129823129858
- organization
129824129859
- app
129860+
dismissal-request-code-scanning-created:
129861+
post:
129862+
summary: |-
129863+
This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
129864+
129865+
To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission.
129866+
129867+
> [!NOTE]
129868+
> Delegated alert dismissal for code scanning is currently in public preview and subject to change.
129869+
description: A code scanning alert dismissal request was created.
129870+
operationId: dismissal-request-code-scanning/created
129871+
externalDocs:
129872+
url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning
129873+
parameters:
129874+
- name: User-Agent
129875+
in: header
129876+
example: GitHub-Hookshot/123abc
129877+
schema:
129878+
type: string
129879+
- name: X-Github-Hook-Id
129880+
in: header
129881+
example: 12312312
129882+
schema:
129883+
type: string
129884+
- name: X-Github-Event
129885+
in: header
129886+
example: issues
129887+
schema:
129888+
type: string
129889+
- name: X-Github-Hook-Installation-Target-Id
129890+
in: header
129891+
example: 123123
129892+
schema:
129893+
type: string
129894+
- name: X-Github-Hook-Installation-Target-Type
129895+
in: header
129896+
example: repository
129897+
schema:
129898+
type: string
129899+
- name: X-GitHub-Delivery
129900+
in: header
129901+
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
129902+
schema:
129903+
type: string
129904+
- name: X-Hub-Signature-256
129905+
in: header
129906+
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
129907+
schema:
129908+
type: string
129909+
requestBody:
129910+
required: true
129911+
content:
129912+
application/json:
129913+
schema: *733
129914+
responses:
129915+
'200':
129916+
description: Return a 200 status to indicate that the data was received
129917+
successfully
129918+
x-github:
129919+
githubCloudOnly: true
129920+
category: webhooks
129921+
subcategory: dismissal_request_code_scanning
129922+
supported-webhook-types:
129923+
- repository
129924+
- organization
129925+
- app
129926+
dismissal-request-code-scanning-response-submitted:
129927+
post:
129928+
summary: |-
129929+
This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
129930+
129931+
To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission.
129932+
129933+
> [!NOTE]
129934+
> Delegated alert dismissal for code scanning is currently in public preview and subject to change.
129935+
description: A code scanning alert dismissal response was submitted.
129936+
operationId: dismissal-request-code-scanning/response-submitted
129937+
externalDocs:
129938+
url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning
129939+
parameters:
129940+
- name: User-Agent
129941+
in: header
129942+
example: GitHub-Hookshot/123abc
129943+
schema:
129944+
type: string
129945+
- name: X-Github-Hook-Id
129946+
in: header
129947+
example: 12312312
129948+
schema:
129949+
type: string
129950+
- name: X-Github-Event
129951+
in: header
129952+
example: issues
129953+
schema:
129954+
type: string
129955+
- name: X-Github-Hook-Installation-Target-Id
129956+
in: header
129957+
example: 123123
129958+
schema:
129959+
type: string
129960+
- name: X-Github-Hook-Installation-Target-Type
129961+
in: header
129962+
example: repository
129963+
schema:
129964+
type: string
129965+
- name: X-GitHub-Delivery
129966+
in: header
129967+
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
129968+
schema:
129969+
type: string
129970+
- name: X-Hub-Signature-256
129971+
in: header
129972+
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
129973+
schema:
129974+
type: string
129975+
requestBody:
129976+
required: true
129977+
content:
129978+
application/json:
129979+
schema: *735
129980+
responses:
129981+
'200':
129982+
description: Return a 200 status to indicate that the data was received
129983+
successfully
129984+
x-github:
129985+
githubCloudOnly: true
129986+
category: webhooks
129987+
subcategory: dismissal_request_code_scanning
129988+
supported-webhook-types:
129989+
- repository
129990+
- organization
129991+
- app
129825129992
dismissal-request-secret-scanning-cancelled:
129826129993
post:
129827129994
summary: |-

0 commit comments

Comments
 (0)