Skip to content

Commit 3bffade

Browse files
jencarluccijencarlucci
authored
Merge pull request #4384 from github/openapi-update-65d36e9e4f84387ab48e61b6ffceb0e22723b38f8f41ad7f1313abec3ccda35c
Update OpenAPI 3.0 Descriptions
2 parents 17a7420 + 62fa60d commit 3bffade

16 files changed

+8448
-0
lines changed

‎descriptions/api.github.com/api.github.com.2022-11-28.json‎

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87643,6 +87643,99 @@
8764387643
}
8764487644
}
8764587645
},
87646+
"secret-scanning-scan-completed": {
87647+
"post": {
87648+
"summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.",
87649+
"description": "A secret scanning scan was completed.",
87650+
"operationId": "secret-scanning-scan/completed",
87651+
"externalDocs": {
87652+
"url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan"
87653+
},
87654+
"parameters": [
87655+
{
87656+
"name": "User-Agent",
87657+
"in": "header",
87658+
"example": "GitHub-Hookshot/123abc",
87659+
"schema": {
87660+
"type": "string"
87661+
}
87662+
},
87663+
{
87664+
"name": "X-Github-Hook-Id",
87665+
"in": "header",
87666+
"example": 12312312,
87667+
"schema": {
87668+
"type": "string"
87669+
}
87670+
},
87671+
{
87672+
"name": "X-Github-Event",
87673+
"in": "header",
87674+
"example": "issues",
87675+
"schema": {
87676+
"type": "string"
87677+
}
87678+
},
87679+
{
87680+
"name": "X-Github-Hook-Installation-Target-Id",
87681+
"in": "header",
87682+
"example": 123123,
87683+
"schema": {
87684+
"type": "string"
87685+
}
87686+
},
87687+
{
87688+
"name": "X-Github-Hook-Installation-Target-Type",
87689+
"in": "header",
87690+
"example": "repository",
87691+
"schema": {
87692+
"type": "string"
87693+
}
87694+
},
87695+
{
87696+
"name": "X-GitHub-Delivery",
87697+
"in": "header",
87698+
"example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
87699+
"schema": {
87700+
"type": "string"
87701+
}
87702+
},
87703+
{
87704+
"name": "X-Hub-Signature-256",
87705+
"in": "header",
87706+
"example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
87707+
"schema": {
87708+
"type": "string"
87709+
}
87710+
}
87711+
],
87712+
"requestBody": {
87713+
"required": true,
87714+
"content": {
87715+
"application/json": {
87716+
"schema": {
87717+
"$ref": "#/components/schemas/webhook-secret-scanning-scan-completed"
87718+
}
87719+
}
87720+
}
87721+
},
87722+
"responses": {
87723+
"200": {
87724+
"description": "Return a 200 status to indicate that the data was received successfully"
87725+
}
87726+
},
87727+
"x-github": {
87728+
"githubCloudOnly": false,
87729+
"category": "webhooks",
87730+
"subcategory": "secret_scanning_scan",
87731+
"supported-webhook-types": [
87732+
"repository",
87733+
"organization",
87734+
"app"
87735+
]
87736+
}
87737+
}
87738+
},
8764687739
"security-advisory-published": {
8764787740
"post": {
8764887741
"summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"",
@@ -252816,6 +252909,93 @@
252816252909
"repository"
252817252910
]
252818252911
},
252912+
"webhook-secret-scanning-scan-completed": {
252913+
"title": "secret_scanning_scan completed event",
252914+
"type": "object",
252915+
"properties": {
252916+
"action": {
252917+
"type": "string",
252918+
"enum": [
252919+
"completed"
252920+
]
252921+
},
252922+
"type": {
252923+
"type": "string",
252924+
"description": "What type of scan was completed",
252925+
"enum": [
252926+
"backfill",
252927+
"custom-pattern-backfill",
252928+
"pattern-version-backfill"
252929+
]
252930+
},
252931+
"source": {
252932+
"type": "string",
252933+
"description": "What type of content was scanned",
252934+
"enum": [
252935+
"git",
252936+
"issues",
252937+
"pull-requests",
252938+
"discussions",
252939+
"wiki"
252940+
]
252941+
},
252942+
"started_at": {
252943+
"type": "string",
252944+
"format": "date-time",
252945+
"description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
252946+
},
252947+
"completed_at": {
252948+
"type": "string",
252949+
"format": "date-time",
252950+
"description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
252951+
},
252952+
"secret_types": {
252953+
"type": "array",
252954+
"description": "List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates",
252955+
"items": {
252956+
"type": "string"
252957+
},
252958+
"nullable": true
252959+
},
252960+
"custom_pattern_name": {
252961+
"type": "string",
252962+
"description": "If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated",
252963+
"nullable": true
252964+
},
252965+
"custom_pattern_scope": {
252966+
"type": "string",
252967+
"description": "If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated",
252968+
"enum": [
252969+
"repository",
252970+
"organization",
252971+
"enterprise"
252972+
],
252973+
"nullable": true
252974+
},
252975+
"repository": {
252976+
"$ref": "#/components/schemas/repository-webhooks"
252977+
},
252978+
"enterprise": {
252979+
"$ref": "#/components/schemas/enterprise-webhooks"
252980+
},
252981+
"installation": {
252982+
"$ref": "#/components/schemas/simple-installation"
252983+
},
252984+
"organization": {
252985+
"$ref": "#/components/schemas/organization-simple-webhooks"
252986+
},
252987+
"sender": {
252988+
"$ref": "#/components/schemas/simple-user"
252989+
}
252990+
},
252991+
"required": [
252992+
"action",
252993+
"source",
252994+
"type",
252995+
"started_at",
252996+
"completed_at"
252997+
]
252998+
},
252819252999
"webhook-security-advisory-published": {
252820253000
"title": "security_advisory published event",
252821253001
"type": "object",

‎descriptions/api.github.com/api.github.com.2022-11-28.yaml‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63267,6 +63267,73 @@ x-webhooks:
6326763267
- repository
6326863268
- organization
6326963269
- app
63270+
secret-scanning-scan-completed:
63271+
post:
63272+
summary: |-
63273+
This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)."
63274+
63275+
Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates
63276+
to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)."
63277+
63278+
To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.
63279+
description: A secret scanning scan was completed.
63280+
operationId: secret-scanning-scan/completed
63281+
externalDocs:
63282+
url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan
63283+
parameters:
63284+
- name: User-Agent
63285+
in: header
63286+
example: GitHub-Hookshot/123abc
63287+
schema:
63288+
type: string
63289+
- name: X-Github-Hook-Id
63290+
in: header
63291+
example: 12312312
63292+
schema:
63293+
type: string
63294+
- name: X-Github-Event
63295+
in: header
63296+
example: issues
63297+
schema:
63298+
type: string
63299+
- name: X-Github-Hook-Installation-Target-Id
63300+
in: header
63301+
example: 123123
63302+
schema:
63303+
type: string
63304+
- name: X-Github-Hook-Installation-Target-Type
63305+
in: header
63306+
example: repository
63307+
schema:
63308+
type: string
63309+
- name: X-GitHub-Delivery
63310+
in: header
63311+
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
63312+
schema:
63313+
type: string
63314+
- name: X-Hub-Signature-256
63315+
in: header
63316+
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
63317+
schema:
63318+
type: string
63319+
requestBody:
63320+
required: true
63321+
content:
63322+
application/json:
63323+
schema:
63324+
"$ref": "#/components/schemas/webhook-secret-scanning-scan-completed"
63325+
responses:
63326+
'200':
63327+
description: Return a 200 status to indicate that the data was received
63328+
successfully
63329+
x-github:
63330+
githubCloudOnly: false
63331+
category: webhooks
63332+
subcategory: secret_scanning_scan
63333+
supported-webhook-types:
63334+
- repository
63335+
- organization
63336+
- app
6327063337
security-advisory-published:
6327163338
post:
6327263339
summary: |-
@@ -188538,6 +188605,75 @@ components:
188538188605
- action
188539188606
- alert
188540188607
- repository
188608+
webhook-secret-scanning-scan-completed:
188609+
title: secret_scanning_scan completed event
188610+
type: object
188611+
properties:
188612+
action:
188613+
type: string
188614+
enum:
188615+
- completed
188616+
type:
188617+
type: string
188618+
description: What type of scan was completed
188619+
enum:
188620+
- backfill
188621+
- custom-pattern-backfill
188622+
- pattern-version-backfill
188623+
source:
188624+
type: string
188625+
description: What type of content was scanned
188626+
enum:
188627+
- git
188628+
- issues
188629+
- pull-requests
188630+
- discussions
188631+
- wiki
188632+
started_at:
188633+
type: string
188634+
format: date-time
188635+
description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
188636+
completed_at:
188637+
type: string
188638+
format: date-time
188639+
description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
188640+
secret_types:
188641+
type: array
188642+
description: List of patterns that were updated. This will be empty for
188643+
normal backfill scans or custom pattern updates
188644+
items:
188645+
type: string
188646+
nullable: true
188647+
custom_pattern_name:
188648+
type: string
188649+
description: If the scan was triggered by a custom pattern update, this
188650+
will be the name of the pattern that was updated
188651+
nullable: true
188652+
custom_pattern_scope:
188653+
type: string
188654+
description: If the scan was triggered by a custom pattern update, this
188655+
will be the scope of the pattern that was updated
188656+
enum:
188657+
- repository
188658+
- organization
188659+
- enterprise
188660+
nullable: true
188661+
repository:
188662+
"$ref": "#/components/schemas/repository-webhooks"
188663+
enterprise:
188664+
"$ref": "#/components/schemas/enterprise-webhooks"
188665+
installation:
188666+
"$ref": "#/components/schemas/simple-installation"
188667+
organization:
188668+
"$ref": "#/components/schemas/organization-simple-webhooks"
188669+
sender:
188670+
"$ref": "#/components/schemas/simple-user"
188671+
required:
188672+
- action
188673+
- source
188674+
- type
188675+
- started_at
188676+
- completed_at
188541188677
webhook-security-advisory-published:
188542188678
title: security_advisory published event
188543188679
type: object

0 commit comments

Comments
 (0)