Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update OpenAPI 3.0 Descriptions #4317

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update OpenAPI 3.0 Descriptions #4317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 179 additions & 0 deletions descriptions/api.github.com/api.github.com.2022-11-28.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53797,6 +53797,57 @@
}
}
},
"/repos/{owner}/{repo}/secret-scanning/scan-history": {
"get": {
"summary": "Get secret scanning scan history for a repository",
"description": "Lists the latest incremental and backfill scans by type for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.",
"tags": [
"secret-scanning"
],
"operationId": "secret-scanning/get-scan-history",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository"
},
"parameters": [
{
"$ref": "#/components/parameters/owner"
},
{
"$ref": "#/components/parameters/repo"
}
],
"responses": {
"404": {
"description": "Repository does not have GitHub Advanced Security or secret scanning enabled"
},
"503": {
"$ref": "#/components/responses/service_unavailable"
},
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/secret-scanning-scan-history"
},
"examples": {
"default": {
"$ref": "#/components/examples/secret-scanning-scan-history"
}
}
}
}
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "secret-scanning",
"subcategory": "secret-scanning"
}
}
},
"/repos/{owner}/{repo}/security-advisories": {
"get": {
"summary": "List repository security advisories",
Expand Down Expand Up @@ -120019,6 +120070,77 @@
}
}
},
"secret-scanning-scan": {
"description": "Information on a single scan performed by secret scanning on the repository",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of scan"
},
"status": {
"type": "string",
"description": "The state of the scan. Either \"completed\" or \"running\""
},
"completed_at": {
"type": "string",
"format": "date-time",
"description": "The time that the scan was completed. Empty if the scan is active",
"nullable": true
},
"started_at": {
"type": "string",
"format": "date-time",
"description": "The time that the scan was started"
}
}
},
"secret-scanning-scan-history": {
"type": "object",
"properties": {
"incremental_scans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/secret-scanning-scan"
}
},
"pattern_update_scans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/secret-scanning-scan"
}
},
"backfill_scans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/secret-scanning-scan"
}
},
"custom_pattern_backfill_scans": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/secret-scanning-scan"
},
{
"type": "object",
"properties": {
"pattern_name": {
"type": "string",
"description": "Name of the custom pattern for custom pattern scans"
},
"pattern_scope": {
"type": "string",
"description": "Level at which the custom pattern is defined, one of \"repository\", \"organization\", or \"enterprise\""
}
}
}
]
}
}
}
},
"repository-advisory-create": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -286192,6 +286314,63 @@
"token_type": "mailchimp_api_key"
}
},
"secret-scanning-scan-history": {
"value": {
"incremental_scans": [
{
"type": "git",
"status": "completed",
"completed_at": "2024-10-07T02:47:00Z"
}
],
"backfill_scans": [
{
"type": "git",
"status": "completed",
"started_at": "2024-10-07T02:47:00Z",
"completed_at": "2024-10-07T02:50:00Z"
},
{
"type": "issue",
"status": "completed",
"started_at": "2024-10-07T02:47:00Z",
"completed_at": "2024-10-07T02:49:00Z"
},
{
"type": "discussion",
"status": "completed",
"started_at": "2024-10-07T02:47:00Z",
"completed_at": "2024-10-07T02:48:00Z"
}
],
"pattern_update_scans": [
{
"type": "discussion",
"status": "in_progress",
"started_at": "2024-10-07T02:47:00Z",
"completed_at": "2024-10-07T02:51:00Z"
}
],
"custom_pattern_backfill_scans": [
{
"type": "git",
"status": "completed",
"started_at": "2024-10-07T02:47:00Z",
"completed_at": "2024-10-07T02:55:00Z",
"pattern_slug": "my-custom-pattern",
"pattern_scope": "enterprise"
},
{
"type": "git",
"status": "completed",
"started_at": "2024-10-07T02:47:00Z",
"completed_at": "2024-10-07T02:55:00Z",
"pattern_slug": "my-custom-pattern",
"pattern_scope": "organization"
}
]
}
},
"repository-advisory": {
"value": {
"ghsa_id": "GHSA-abcd-1234-efgh",
Expand Down
123 changes: 123 additions & 0 deletions descriptions/api.github.com/api.github.com.2022-11-28.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39023,6 +39023,42 @@ paths:
githubCloudOnly: false
category: secret-scanning
subcategory: secret-scanning
"/repos/{owner}/{repo}/secret-scanning/scan-history":
get:
summary: Get secret scanning scan history for a repository
description: |-
Lists the latest incremental and backfill scans by type for a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
tags:
- secret-scanning
operationId: secret-scanning/get-scan-history
externalDocs:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository
parameters:
- "$ref": "#/components/parameters/owner"
- "$ref": "#/components/parameters/repo"
responses:
'404':
description: Repository does not have GitHub Advanced Security or secret
scanning enabled
'503':
"$ref": "#/components/responses/service_unavailable"
'200':
description: Response
content:
application/json:
schema:
"$ref": "#/components/schemas/secret-scanning-scan-history"
examples:
default:
"$ref": "#/components/examples/secret-scanning-scan-history"
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: secret-scanning
subcategory: secret-scanning
"/repos/{owner}/{repo}/security-advisories":
get:
summary: List repository security advisories
Expand Down Expand Up @@ -88431,6 +88467,56 @@ components:
token_type:
type: string
description: The token type this bypass is for.
secret-scanning-scan:
description: Information on a single scan performed by secret scanning on the
repository
type: object
properties:
type:
type: string
description: The type of scan
status:
type: string
description: The state of the scan. Either "completed" or "running"
completed_at:
type: string
format: date-time
description: The time that the scan was completed. Empty if the scan is
active
nullable: true
started_at:
type: string
format: date-time
description: The time that the scan was started
secret-scanning-scan-history:
type: object
properties:
incremental_scans:
type: array
items:
"$ref": "#/components/schemas/secret-scanning-scan"
pattern_update_scans:
type: array
items:
"$ref": "#/components/schemas/secret-scanning-scan"
backfill_scans:
type: array
items:
"$ref": "#/components/schemas/secret-scanning-scan"
custom_pattern_backfill_scans:
type: array
items:
allOf:
- "$ref": "#/components/schemas/secret-scanning-scan"
- type: object
properties:
pattern_name:
type: string
description: Name of the custom pattern for custom pattern scans
pattern_scope:
type: string
description: Level at which the custom pattern is defined, one of
"repository", "organization", or "enterprise"
repository-advisory-create:
type: object
properties:
Expand Down Expand Up @@ -216618,6 +216704,43 @@ components:
reason: will_fix_later
expire_at: '2020-11-06T18:18:30Z'
token_type: mailchimp_api_key
secret-scanning-scan-history:
value:
incremental_scans:
- type: git
status: completed
completed_at: '2024-10-07T02:47:00Z'
backfill_scans:
- type: git
status: completed
started_at: '2024-10-07T02:47:00Z'
completed_at: '2024-10-07T02:50:00Z'
- type: issue
status: completed
started_at: '2024-10-07T02:47:00Z'
completed_at: '2024-10-07T02:49:00Z'
- type: discussion
status: completed
started_at: '2024-10-07T02:47:00Z'
completed_at: '2024-10-07T02:48:00Z'
pattern_update_scans:
- type: discussion
status: in_progress
started_at: '2024-10-07T02:47:00Z'
completed_at: '2024-10-07T02:51:00Z'
custom_pattern_backfill_scans:
- type: git
status: completed
started_at: '2024-10-07T02:47:00Z'
completed_at: '2024-10-07T02:55:00Z'
pattern_slug: my-custom-pattern
pattern_scope: enterprise
- type: git
status: completed
started_at: '2024-10-07T02:47:00Z'
completed_at: '2024-10-07T02:55:00Z'
pattern_slug: my-custom-pattern
pattern_scope: organization
repository-advisory:
value:
ghsa_id: GHSA-abcd-1234-efgh
Expand Down
Loading