Skip to content

Commit 3f4dec0

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.0 Descriptions
1 parent b2ff88e commit 3f4dec0

16 files changed

+8644
-5908
lines changed

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

Lines changed: 179 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53797,6 +53797,57 @@
5379753797
}
5379853798
}
5379953799
},
53800+
"/repos/{owner}/{repo}/secret-scanning/scan-history": {
53801+
"get": {
53802+
"summary": "Get secret scanning scan history for a repository",
53803+
"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.",
53804+
"tags": [
53805+
"secret-scanning"
53806+
],
53807+
"operationId": "secret-scanning/get-scan-history",
53808+
"externalDocs": {
53809+
"description": "API method documentation",
53810+
"url": "https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository"
53811+
},
53812+
"parameters": [
53813+
{
53814+
"$ref": "#/components/parameters/owner"
53815+
},
53816+
{
53817+
"$ref": "#/components/parameters/repo"
53818+
}
53819+
],
53820+
"responses": {
53821+
"404": {
53822+
"description": "Repository does not have GitHub Advanced Security or secret scanning enabled"
53823+
},
53824+
"503": {
53825+
"$ref": "#/components/responses/service_unavailable"
53826+
},
53827+
"200": {
53828+
"description": "Response",
53829+
"content": {
53830+
"application/json": {
53831+
"schema": {
53832+
"$ref": "#/components/schemas/secret-scanning-scan-history"
53833+
},
53834+
"examples": {
53835+
"default": {
53836+
"$ref": "#/components/examples/secret-scanning-scan-history"
53837+
}
53838+
}
53839+
}
53840+
}
53841+
}
53842+
},
53843+
"x-github": {
53844+
"githubCloudOnly": false,
53845+
"enabledForGitHubApps": true,
53846+
"category": "secret-scanning",
53847+
"subcategory": "secret-scanning"
53848+
}
53849+
}
53850+
},
5380053851
"/repos/{owner}/{repo}/security-advisories": {
5380153852
"get": {
5380253853
"summary": "List repository security advisories",
@@ -120019,6 +120070,77 @@
120019120070
}
120020120071
}
120021120072
},
120073+
"secret-scanning-scan": {
120074+
"description": "Information on a single scan performed by secret scanning on the repository",
120075+
"type": "object",
120076+
"properties": {
120077+
"type": {
120078+
"type": "string",
120079+
"description": "The type of scan"
120080+
},
120081+
"status": {
120082+
"type": "string",
120083+
"description": "The state of the scan. Either \"completed\" or \"running\""
120084+
},
120085+
"completed_at": {
120086+
"type": "string",
120087+
"format": "date-time",
120088+
"description": "The time that the scan was completed. Empty if the scan is active",
120089+
"nullable": true
120090+
},
120091+
"started_at": {
120092+
"type": "string",
120093+
"format": "date-time",
120094+
"description": "The time that the scan was started"
120095+
}
120096+
}
120097+
},
120098+
"secret-scanning-scan-history": {
120099+
"type": "object",
120100+
"properties": {
120101+
"incremental_scans": {
120102+
"type": "array",
120103+
"items": {
120104+
"$ref": "#/components/schemas/secret-scanning-scan"
120105+
}
120106+
},
120107+
"pattern_update_scans": {
120108+
"type": "array",
120109+
"items": {
120110+
"$ref": "#/components/schemas/secret-scanning-scan"
120111+
}
120112+
},
120113+
"backfill_scans": {
120114+
"type": "array",
120115+
"items": {
120116+
"$ref": "#/components/schemas/secret-scanning-scan"
120117+
}
120118+
},
120119+
"custom_pattern_backfill_scans": {
120120+
"type": "array",
120121+
"items": {
120122+
"allOf": [
120123+
{
120124+
"$ref": "#/components/schemas/secret-scanning-scan"
120125+
},
120126+
{
120127+
"type": "object",
120128+
"properties": {
120129+
"pattern_name": {
120130+
"type": "string",
120131+
"description": "Name of the custom pattern for custom pattern scans"
120132+
},
120133+
"pattern_scope": {
120134+
"type": "string",
120135+
"description": "Level at which the custom pattern is defined, one of \"repository\", \"organization\", or \"enterprise\""
120136+
}
120137+
}
120138+
}
120139+
]
120140+
}
120141+
}
120142+
}
120143+
},
120022120144
"repository-advisory-create": {
120023120145
"type": "object",
120024120146
"properties": {
@@ -286192,6 +286314,63 @@
286192286314
"token_type": "mailchimp_api_key"
286193286315
}
286194286316
},
286317+
"secret-scanning-scan-history": {
286318+
"value": {
286319+
"incremental_scans": [
286320+
{
286321+
"type": "git",
286322+
"status": "completed",
286323+
"completed_at": "2024-10-07T02:47:00Z"
286324+
}
286325+
],
286326+
"backfill_scans": [
286327+
{
286328+
"type": "git",
286329+
"status": "completed",
286330+
"started_at": "2024-10-07T02:47:00Z",
286331+
"completed_at": "2024-10-07T02:50:00Z"
286332+
},
286333+
{
286334+
"type": "issue",
286335+
"status": "completed",
286336+
"started_at": "2024-10-07T02:47:00Z",
286337+
"completed_at": "2024-10-07T02:49:00Z"
286338+
},
286339+
{
286340+
"type": "discussion",
286341+
"status": "completed",
286342+
"started_at": "2024-10-07T02:47:00Z",
286343+
"completed_at": "2024-10-07T02:48:00Z"
286344+
}
286345+
],
286346+
"pattern_update_scans": [
286347+
{
286348+
"type": "discussion",
286349+
"status": "in_progress",
286350+
"started_at": "2024-10-07T02:47:00Z",
286351+
"completed_at": "2024-10-07T02:51:00Z"
286352+
}
286353+
],
286354+
"custom_pattern_backfill_scans": [
286355+
{
286356+
"type": "git",
286357+
"status": "completed",
286358+
"started_at": "2024-10-07T02:47:00Z",
286359+
"completed_at": "2024-10-07T02:55:00Z",
286360+
"pattern_slug": "my-custom-pattern",
286361+
"pattern_scope": "enterprise"
286362+
},
286363+
{
286364+
"type": "git",
286365+
"status": "completed",
286366+
"started_at": "2024-10-07T02:47:00Z",
286367+
"completed_at": "2024-10-07T02:55:00Z",
286368+
"pattern_slug": "my-custom-pattern",
286369+
"pattern_scope": "organization"
286370+
}
286371+
]
286372+
}
286373+
},
286195286374
"repository-advisory": {
286196286375
"value": {
286197286376
"ghsa_id": "GHSA-abcd-1234-efgh",

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

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39023,6 +39023,42 @@ paths:
3902339023
githubCloudOnly: false
3902439024
category: secret-scanning
3902539025
subcategory: secret-scanning
39026+
"/repos/{owner}/{repo}/secret-scanning/scan-history":
39027+
get:
39028+
summary: Get secret scanning scan history for a repository
39029+
description: |-
39030+
Lists the latest incremental and backfill scans by type for a repository.
39031+
39032+
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.
39033+
tags:
39034+
- secret-scanning
39035+
operationId: secret-scanning/get-scan-history
39036+
externalDocs:
39037+
description: API method documentation
39038+
url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository
39039+
parameters:
39040+
- "$ref": "#/components/parameters/owner"
39041+
- "$ref": "#/components/parameters/repo"
39042+
responses:
39043+
'404':
39044+
description: Repository does not have GitHub Advanced Security or secret
39045+
scanning enabled
39046+
'503':
39047+
"$ref": "#/components/responses/service_unavailable"
39048+
'200':
39049+
description: Response
39050+
content:
39051+
application/json:
39052+
schema:
39053+
"$ref": "#/components/schemas/secret-scanning-scan-history"
39054+
examples:
39055+
default:
39056+
"$ref": "#/components/examples/secret-scanning-scan-history"
39057+
x-github:
39058+
githubCloudOnly: false
39059+
enabledForGitHubApps: true
39060+
category: secret-scanning
39061+
subcategory: secret-scanning
3902639062
"/repos/{owner}/{repo}/security-advisories":
3902739063
get:
3902839064
summary: List repository security advisories
@@ -88431,6 +88467,56 @@ components:
8843188467
token_type:
8843288468
type: string
8843388469
description: The token type this bypass is for.
88470+
secret-scanning-scan:
88471+
description: Information on a single scan performed by secret scanning on the
88472+
repository
88473+
type: object
88474+
properties:
88475+
type:
88476+
type: string
88477+
description: The type of scan
88478+
status:
88479+
type: string
88480+
description: The state of the scan. Either "completed" or "running"
88481+
completed_at:
88482+
type: string
88483+
format: date-time
88484+
description: The time that the scan was completed. Empty if the scan is
88485+
active
88486+
nullable: true
88487+
started_at:
88488+
type: string
88489+
format: date-time
88490+
description: The time that the scan was started
88491+
secret-scanning-scan-history:
88492+
type: object
88493+
properties:
88494+
incremental_scans:
88495+
type: array
88496+
items:
88497+
"$ref": "#/components/schemas/secret-scanning-scan"
88498+
pattern_update_scans:
88499+
type: array
88500+
items:
88501+
"$ref": "#/components/schemas/secret-scanning-scan"
88502+
backfill_scans:
88503+
type: array
88504+
items:
88505+
"$ref": "#/components/schemas/secret-scanning-scan"
88506+
custom_pattern_backfill_scans:
88507+
type: array
88508+
items:
88509+
allOf:
88510+
- "$ref": "#/components/schemas/secret-scanning-scan"
88511+
- type: object
88512+
properties:
88513+
pattern_name:
88514+
type: string
88515+
description: Name of the custom pattern for custom pattern scans
88516+
pattern_scope:
88517+
type: string
88518+
description: Level at which the custom pattern is defined, one of
88519+
"repository", "organization", or "enterprise"
8843488520
repository-advisory-create:
8843588521
type: object
8843688522
properties:
@@ -216618,6 +216704,43 @@ components:
216618216704
reason: will_fix_later
216619216705
expire_at: '2020-11-06T18:18:30Z'
216620216706
token_type: mailchimp_api_key
216707+
secret-scanning-scan-history:
216708+
value:
216709+
incremental_scans:
216710+
- type: git
216711+
status: completed
216712+
completed_at: '2024-10-07T02:47:00Z'
216713+
backfill_scans:
216714+
- type: git
216715+
status: completed
216716+
started_at: '2024-10-07T02:47:00Z'
216717+
completed_at: '2024-10-07T02:50:00Z'
216718+
- type: issue
216719+
status: completed
216720+
started_at: '2024-10-07T02:47:00Z'
216721+
completed_at: '2024-10-07T02:49:00Z'
216722+
- type: discussion
216723+
status: completed
216724+
started_at: '2024-10-07T02:47:00Z'
216725+
completed_at: '2024-10-07T02:48:00Z'
216726+
pattern_update_scans:
216727+
- type: discussion
216728+
status: in_progress
216729+
started_at: '2024-10-07T02:47:00Z'
216730+
completed_at: '2024-10-07T02:51:00Z'
216731+
custom_pattern_backfill_scans:
216732+
- type: git
216733+
status: completed
216734+
started_at: '2024-10-07T02:47:00Z'
216735+
completed_at: '2024-10-07T02:55:00Z'
216736+
pattern_slug: my-custom-pattern
216737+
pattern_scope: enterprise
216738+
- type: git
216739+
status: completed
216740+
started_at: '2024-10-07T02:47:00Z'
216741+
completed_at: '2024-10-07T02:55:00Z'
216742+
pattern_slug: my-custom-pattern
216743+
pattern_scope: organization
216621216744
repository-advisory:
216622216745
value:
216623216746
ghsa_id: GHSA-abcd-1234-efgh

0 commit comments

Comments
 (0)