Skip to content

Commit 07ac4fc

Browse files
jencarluccijencarlucci
authored
Merge pull request #4385 from github/openapi-update-bd7bf77a5e3208ba3aa9d1851c63d2f97a820323675a9e8af76a6cf772144336
Update OpenAPI 3.1 Descriptions
2 parents 3bffade + 6307b40 commit 07ac4fc

16 files changed

+10008
-0
lines changed

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

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87982,6 +87982,99 @@
8798287982
}
8798387983
}
8798487984
},
87985+
"secret-scanning-scan-completed": {
87986+
"post": {
87987+
"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.",
87988+
"description": "A secret scanning scan was completed.",
87989+
"operationId": "secret-scanning-scan/completed",
87990+
"externalDocs": {
87991+
"url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan"
87992+
},
87993+
"parameters": [
87994+
{
87995+
"name": "User-Agent",
87996+
"in": "header",
87997+
"example": "GitHub-Hookshot/123abc",
87998+
"schema": {
87999+
"type": "string"
88000+
}
88001+
},
88002+
{
88003+
"name": "X-Github-Hook-Id",
88004+
"in": "header",
88005+
"example": 12312312,
88006+
"schema": {
88007+
"type": "string"
88008+
}
88009+
},
88010+
{
88011+
"name": "X-Github-Event",
88012+
"in": "header",
88013+
"example": "issues",
88014+
"schema": {
88015+
"type": "string"
88016+
}
88017+
},
88018+
{
88019+
"name": "X-Github-Hook-Installation-Target-Id",
88020+
"in": "header",
88021+
"example": 123123,
88022+
"schema": {
88023+
"type": "string"
88024+
}
88025+
},
88026+
{
88027+
"name": "X-Github-Hook-Installation-Target-Type",
88028+
"in": "header",
88029+
"example": "repository",
88030+
"schema": {
88031+
"type": "string"
88032+
}
88033+
},
88034+
{
88035+
"name": "X-GitHub-Delivery",
88036+
"in": "header",
88037+
"example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
88038+
"schema": {
88039+
"type": "string"
88040+
}
88041+
},
88042+
{
88043+
"name": "X-Hub-Signature-256",
88044+
"in": "header",
88045+
"example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
88046+
"schema": {
88047+
"type": "string"
88048+
}
88049+
}
88050+
],
88051+
"requestBody": {
88052+
"required": true,
88053+
"content": {
88054+
"application/json": {
88055+
"schema": {
88056+
"$ref": "#/components/schemas/webhook-secret-scanning-scan-completed"
88057+
}
88058+
}
88059+
}
88060+
},
88061+
"responses": {
88062+
"200": {
88063+
"description": "Return a 200 status to indicate that the data was received successfully"
88064+
}
88065+
},
88066+
"x-github": {
88067+
"githubCloudOnly": false,
88068+
"category": "webhooks",
88069+
"subcategory": "secret_scanning_scan",
88070+
"supported-webhook-types": [
88071+
"repository",
88072+
"organization",
88073+
"app"
88074+
]
88075+
}
88076+
}
88077+
},
8798588078
"security-advisory-published": {
8798688079
"post": {
8798788080
"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).\"",
@@ -261276,6 +261369,100 @@
261276261369
"repository"
261277261370
]
261278261371
},
261372+
"webhook-secret-scanning-scan-completed": {
261373+
"title": "secret_scanning_scan completed event",
261374+
"type": "object",
261375+
"properties": {
261376+
"action": {
261377+
"type": "string",
261378+
"enum": [
261379+
"completed"
261380+
]
261381+
},
261382+
"type": {
261383+
"type": "string",
261384+
"description": "What type of scan was completed",
261385+
"enum": [
261386+
"backfill",
261387+
"custom-pattern-backfill",
261388+
"pattern-version-backfill"
261389+
]
261390+
},
261391+
"source": {
261392+
"type": "string",
261393+
"description": "What type of content was scanned",
261394+
"enum": [
261395+
"git",
261396+
"issues",
261397+
"pull-requests",
261398+
"discussions",
261399+
"wiki"
261400+
]
261401+
},
261402+
"started_at": {
261403+
"type": "string",
261404+
"format": "date-time",
261405+
"description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
261406+
},
261407+
"completed_at": {
261408+
"type": "string",
261409+
"format": "date-time",
261410+
"description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
261411+
},
261412+
"secret_types": {
261413+
"type": [
261414+
"array",
261415+
"null"
261416+
],
261417+
"description": "List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates",
261418+
"items": {
261419+
"type": "string"
261420+
}
261421+
},
261422+
"custom_pattern_name": {
261423+
"type": [
261424+
"string",
261425+
"null"
261426+
],
261427+
"description": "If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated"
261428+
},
261429+
"custom_pattern_scope": {
261430+
"type": [
261431+
"string",
261432+
"null"
261433+
],
261434+
"description": "If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated",
261435+
"enum": [
261436+
"repository",
261437+
"organization",
261438+
"enterprise",
261439+
null
261440+
]
261441+
},
261442+
"repository": {
261443+
"$ref": "#/components/schemas/repository-webhooks"
261444+
},
261445+
"enterprise": {
261446+
"$ref": "#/components/schemas/enterprise-webhooks"
261447+
},
261448+
"installation": {
261449+
"$ref": "#/components/schemas/simple-installation"
261450+
},
261451+
"organization": {
261452+
"$ref": "#/components/schemas/organization-simple-webhooks"
261453+
},
261454+
"sender": {
261455+
"$ref": "#/components/schemas/simple-user"
261456+
}
261457+
},
261458+
"required": [
261459+
"action",
261460+
"source",
261461+
"type",
261462+
"started_at",
261463+
"completed_at"
261464+
]
261465+
},
261279261466
"webhook-security-advisory-published": {
261280261467
"title": "security_advisory published event",
261281261468
"type": "object",

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

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63436,6 +63436,73 @@ webhooks:
6343663436
- repository
6343763437
- organization
6343863438
- app
63439+
secret-scanning-scan-completed:
63440+
post:
63441+
summary: |-
63442+
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)."
63443+
63444+
Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates
63445+
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)."
63446+
63447+
To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.
63448+
description: A secret scanning scan was completed.
63449+
operationId: secret-scanning-scan/completed
63450+
externalDocs:
63451+
url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan
63452+
parameters:
63453+
- name: User-Agent
63454+
in: header
63455+
example: GitHub-Hookshot/123abc
63456+
schema:
63457+
type: string
63458+
- name: X-Github-Hook-Id
63459+
in: header
63460+
example: 12312312
63461+
schema:
63462+
type: string
63463+
- name: X-Github-Event
63464+
in: header
63465+
example: issues
63466+
schema:
63467+
type: string
63468+
- name: X-Github-Hook-Installation-Target-Id
63469+
in: header
63470+
example: 123123
63471+
schema:
63472+
type: string
63473+
- name: X-Github-Hook-Installation-Target-Type
63474+
in: header
63475+
example: repository
63476+
schema:
63477+
type: string
63478+
- name: X-GitHub-Delivery
63479+
in: header
63480+
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
63481+
schema:
63482+
type: string
63483+
- name: X-Hub-Signature-256
63484+
in: header
63485+
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
63486+
schema:
63487+
type: string
63488+
requestBody:
63489+
required: true
63490+
content:
63491+
application/json:
63492+
schema:
63493+
"$ref": "#/components/schemas/webhook-secret-scanning-scan-completed"
63494+
responses:
63495+
'200':
63496+
description: Return a 200 status to indicate that the data was received
63497+
successfully
63498+
x-github:
63499+
githubCloudOnly: false
63500+
category: webhooks
63501+
subcategory: secret_scanning_scan
63502+
supported-webhook-types:
63503+
- repository
63504+
- organization
63505+
- app
6343963506
security-advisory-published:
6344063507
post:
6344163508
summary: |-
@@ -191719,6 +191786,79 @@ components:
191719191786
- action
191720191787
- alert
191721191788
- repository
191789+
webhook-secret-scanning-scan-completed:
191790+
title: secret_scanning_scan completed event
191791+
type: object
191792+
properties:
191793+
action:
191794+
type: string
191795+
enum:
191796+
- completed
191797+
type:
191798+
type: string
191799+
description: What type of scan was completed
191800+
enum:
191801+
- backfill
191802+
- custom-pattern-backfill
191803+
- pattern-version-backfill
191804+
source:
191805+
type: string
191806+
description: What type of content was scanned
191807+
enum:
191808+
- git
191809+
- issues
191810+
- pull-requests
191811+
- discussions
191812+
- wiki
191813+
started_at:
191814+
type: string
191815+
format: date-time
191816+
description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
191817+
completed_at:
191818+
type: string
191819+
format: date-time
191820+
description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
191821+
secret_types:
191822+
type:
191823+
- array
191824+
- 'null'
191825+
description: List of patterns that were updated. This will be empty for
191826+
normal backfill scans or custom pattern updates
191827+
items:
191828+
type: string
191829+
custom_pattern_name:
191830+
type:
191831+
- string
191832+
- 'null'
191833+
description: If the scan was triggered by a custom pattern update, this
191834+
will be the name of the pattern that was updated
191835+
custom_pattern_scope:
191836+
type:
191837+
- string
191838+
- 'null'
191839+
description: If the scan was triggered by a custom pattern update, this
191840+
will be the scope of the pattern that was updated
191841+
enum:
191842+
- repository
191843+
- organization
191844+
- enterprise
191845+
-
191846+
repository:
191847+
"$ref": "#/components/schemas/repository-webhooks"
191848+
enterprise:
191849+
"$ref": "#/components/schemas/enterprise-webhooks"
191850+
installation:
191851+
"$ref": "#/components/schemas/simple-installation"
191852+
organization:
191853+
"$ref": "#/components/schemas/organization-simple-webhooks"
191854+
sender:
191855+
"$ref": "#/components/schemas/simple-user"
191856+
required:
191857+
- action
191858+
- source
191859+
- type
191860+
- started_at
191861+
- completed_at
191722191862
webhook-security-advisory-published:
191723191863
title: security_advisory published event
191724191864
type: object

0 commit comments

Comments
 (0)