Skip to content

Commit

Permalink
Update OpenAPI 3.1 Descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-openapi-bot
github-openapi-bot committed Dec 12, 2024
1 parent 17a7420 commit 8d53136
Show file tree
Hide file tree
Showing 16 changed files with 10,008 additions and 0 deletions.
187 changes: 187 additions & 0 deletions descriptions-next/api.github.com/api.github.com.2022-11-28.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87982,6 +87982,99 @@
}
}
},
"secret-scanning-scan-completed": {
"post": {
"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.",
"description": "A secret scanning scan was completed.",
"operationId": "secret-scanning-scan/completed",
"externalDocs": {
"url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan"
},
"parameters": [
{
"name": "User-Agent",
"in": "header",
"example": "GitHub-Hookshot/123abc",
"schema": {
"type": "string"
}
},
{
"name": "X-Github-Hook-Id",
"in": "header",
"example": 12312312,
"schema": {
"type": "string"
}
},
{
"name": "X-Github-Event",
"in": "header",
"example": "issues",
"schema": {
"type": "string"
}
},
{
"name": "X-Github-Hook-Installation-Target-Id",
"in": "header",
"example": 123123,
"schema": {
"type": "string"
}
},
{
"name": "X-Github-Hook-Installation-Target-Type",
"in": "header",
"example": "repository",
"schema": {
"type": "string"
}
},
{
"name": "X-GitHub-Delivery",
"in": "header",
"example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
"schema": {
"type": "string"
}
},
{
"name": "X-Hub-Signature-256",
"in": "header",
"example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/webhook-secret-scanning-scan-completed"
}
}
}
},
"responses": {
"200": {
"description": "Return a 200 status to indicate that the data was received successfully"
}
},
"x-github": {
"githubCloudOnly": false,
"category": "webhooks",
"subcategory": "secret_scanning_scan",
"supported-webhook-types": [
"repository",
"organization",
"app"
]
}
}
},
"security-advisory-published": {
"post": {
"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).\"",
Expand Down Expand Up @@ -261276,6 +261369,100 @@
"repository"
]
},
"webhook-secret-scanning-scan-completed": {
"title": "secret_scanning_scan completed event",
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"completed"
]
},
"type": {
"type": "string",
"description": "What type of scan was completed",
"enum": [
"backfill",
"custom-pattern-backfill",
"pattern-version-backfill"
]
},
"source": {
"type": "string",
"description": "What type of content was scanned",
"enum": [
"git",
"issues",
"pull-requests",
"discussions",
"wiki"
]
},
"started_at": {
"type": "string",
"format": "date-time",
"description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
},
"completed_at": {
"type": "string",
"format": "date-time",
"description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
},
"secret_types": {
"type": [
"array",
"null"
],
"description": "List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates",
"items": {
"type": "string"
}
},
"custom_pattern_name": {
"type": [
"string",
"null"
],
"description": "If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated"
},
"custom_pattern_scope": {
"type": [
"string",
"null"
],
"description": "If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated",
"enum": [
"repository",
"organization",
"enterprise",
null
]
},
"repository": {
"$ref": "#/components/schemas/repository-webhooks"
},
"enterprise": {
"$ref": "#/components/schemas/enterprise-webhooks"
},
"installation": {
"$ref": "#/components/schemas/simple-installation"
},
"organization": {
"$ref": "#/components/schemas/organization-simple-webhooks"
},
"sender": {
"$ref": "#/components/schemas/simple-user"
}
},
"required": [
"action",
"source",
"type",
"started_at",
"completed_at"
]
},
"webhook-security-advisory-published": {
"title": "security_advisory published event",
"type": "object",
Expand Down
140 changes: 140 additions & 0 deletions descriptions-next/api.github.com/api.github.com.2022-11-28.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63436,6 +63436,73 @@ webhooks:
- repository
- organization
- app
secret-scanning-scan-completed:
post:
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)."

Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates
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)."

To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.
description: A secret scanning scan was completed.
operationId: secret-scanning-scan/completed
externalDocs:
url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
"$ref": "#/components/schemas/webhook-secret-scanning-scan-completed"
responses:
'200':
description: Return a 200 status to indicate that the data was received
successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: secret_scanning_scan
supported-webhook-types:
- repository
- organization
- app
security-advisory-published:
post:
summary: |-
Expand Down Expand Up @@ -191719,6 +191786,79 @@ components:
- action
- alert
- repository
webhook-secret-scanning-scan-completed:
title: secret_scanning_scan completed event
type: object
properties:
action:
type: string
enum:
- completed
type:
type: string
description: What type of scan was completed
enum:
- backfill
- custom-pattern-backfill
- pattern-version-backfill
source:
type: string
description: What type of content was scanned
enum:
- git
- issues
- pull-requests
- discussions
- wiki
started_at:
type: string
format: date-time
description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
completed_at:
type: string
format: date-time
description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
secret_types:
type:
- array
- 'null'
description: List of patterns that were updated. This will be empty for
normal backfill scans or custom pattern updates
items:
type: string
custom_pattern_name:
type:
- string
- 'null'
description: If the scan was triggered by a custom pattern update, this
will be the name of the pattern that was updated
custom_pattern_scope:
type:
- string
- 'null'
description: If the scan was triggered by a custom pattern update, this
will be the scope of the pattern that was updated
enum:
- repository
- organization
- enterprise
-
repository:
"$ref": "#/components/schemas/repository-webhooks"
enterprise:
"$ref": "#/components/schemas/enterprise-webhooks"
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
"$ref": "#/components/schemas/organization-simple-webhooks"
sender:
"$ref": "#/components/schemas/simple-user"
required:
- action
- source
- type
- started_at
- completed_at
webhook-security-advisory-published:
title: security_advisory published event
type: object
Expand Down
Loading

0 comments on commit 8d53136

Please sign in to comment.