Skip to content

Commit 9cbfdee

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.1 Descriptions
1 parent b2ff88e commit 9cbfdee

16 files changed

+8652
-5868
lines changed

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

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54056,6 +54056,57 @@
5405654056
}
5405754057
}
5405854058
},
54059+
"/repos/{owner}/{repo}/secret-scanning/scan-history": {
54060+
"get": {
54061+
"summary": "Get secret scanning scan history for a repository",
54062+
"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.",
54063+
"tags": [
54064+
"secret-scanning"
54065+
],
54066+
"operationId": "secret-scanning/get-scan-history",
54067+
"externalDocs": {
54068+
"description": "API method documentation",
54069+
"url": "https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository"
54070+
},
54071+
"parameters": [
54072+
{
54073+
"$ref": "#/components/parameters/owner"
54074+
},
54075+
{
54076+
"$ref": "#/components/parameters/repo"
54077+
}
54078+
],
54079+
"responses": {
54080+
"404": {
54081+
"description": "Repository does not have GitHub Advanced Security or secret scanning enabled"
54082+
},
54083+
"503": {
54084+
"$ref": "#/components/responses/service_unavailable"
54085+
},
54086+
"200": {
54087+
"description": "Response",
54088+
"content": {
54089+
"application/json": {
54090+
"schema": {
54091+
"$ref": "#/components/schemas/secret-scanning-scan-history"
54092+
},
54093+
"examples": {
54094+
"default": {
54095+
"$ref": "#/components/examples/secret-scanning-scan-history"
54096+
}
54097+
}
54098+
}
54099+
}
54100+
}
54101+
},
54102+
"x-github": {
54103+
"githubCloudOnly": false,
54104+
"enabledForGitHubApps": true,
54105+
"category": "secret-scanning",
54106+
"subcategory": "secret-scanning"
54107+
}
54108+
}
54109+
},
5405954110
"/repos/{owner}/{repo}/security-advisories": {
5406054111
"get": {
5406154112
"summary": "List repository security advisories",
@@ -123336,6 +123387,79 @@
123336123387
}
123337123388
}
123338123389
},
123390+
"secret-scanning-scan": {
123391+
"description": "Information on a single scan performed by secret scanning on the repository",
123392+
"type": "object",
123393+
"properties": {
123394+
"type": {
123395+
"type": "string",
123396+
"description": "The type of scan"
123397+
},
123398+
"status": {
123399+
"type": "string",
123400+
"description": "The state of the scan. Either \"completed\" or \"running\""
123401+
},
123402+
"completed_at": {
123403+
"type": [
123404+
"string",
123405+
"null"
123406+
],
123407+
"format": "date-time",
123408+
"description": "The time that the scan was completed. Empty if the scan is active"
123409+
},
123410+
"started_at": {
123411+
"type": "string",
123412+
"format": "date-time",
123413+
"description": "The time that the scan was started"
123414+
}
123415+
}
123416+
},
123417+
"secret-scanning-scan-history": {
123418+
"type": "object",
123419+
"properties": {
123420+
"incremental_scans": {
123421+
"type": "array",
123422+
"items": {
123423+
"$ref": "#/components/schemas/secret-scanning-scan"
123424+
}
123425+
},
123426+
"pattern_update_scans": {
123427+
"type": "array",
123428+
"items": {
123429+
"$ref": "#/components/schemas/secret-scanning-scan"
123430+
}
123431+
},
123432+
"backfill_scans": {
123433+
"type": "array",
123434+
"items": {
123435+
"$ref": "#/components/schemas/secret-scanning-scan"
123436+
}
123437+
},
123438+
"custom_pattern_backfill_scans": {
123439+
"type": "array",
123440+
"items": {
123441+
"allOf": [
123442+
{
123443+
"$ref": "#/components/schemas/secret-scanning-scan"
123444+
},
123445+
{
123446+
"type": "object",
123447+
"properties": {
123448+
"pattern_name": {
123449+
"type": "string",
123450+
"description": "Name of the custom pattern for custom pattern scans"
123451+
},
123452+
"pattern_scope": {
123453+
"type": "string",
123454+
"description": "Level at which the custom pattern is defined, one of \"repository\", \"organization\", or \"enterprise\""
123455+
}
123456+
}
123457+
}
123458+
]
123459+
}
123460+
}
123461+
}
123462+
},
123339123463
"repository-advisory-create": {
123340123464
"type": "object",
123341123465
"properties": {
@@ -295006,6 +295130,63 @@
295006295130
"token_type": "mailchimp_api_key"
295007295131
}
295008295132
},
295133+
"secret-scanning-scan-history": {
295134+
"value": {
295135+
"incremental_scans": [
295136+
{
295137+
"type": "git",
295138+
"status": "completed",
295139+
"completed_at": "2024-10-07T02:47:00Z"
295140+
}
295141+
],
295142+
"backfill_scans": [
295143+
{
295144+
"type": "git",
295145+
"status": "completed",
295146+
"started_at": "2024-10-07T02:47:00Z",
295147+
"completed_at": "2024-10-07T02:50:00Z"
295148+
},
295149+
{
295150+
"type": "issue",
295151+
"status": "completed",
295152+
"started_at": "2024-10-07T02:47:00Z",
295153+
"completed_at": "2024-10-07T02:49:00Z"
295154+
},
295155+
{
295156+
"type": "discussion",
295157+
"status": "completed",
295158+
"started_at": "2024-10-07T02:47:00Z",
295159+
"completed_at": "2024-10-07T02:48:00Z"
295160+
}
295161+
],
295162+
"pattern_update_scans": [
295163+
{
295164+
"type": "discussion",
295165+
"status": "in_progress",
295166+
"started_at": "2024-10-07T02:47:00Z",
295167+
"completed_at": "2024-10-07T02:51:00Z"
295168+
}
295169+
],
295170+
"custom_pattern_backfill_scans": [
295171+
{
295172+
"type": "git",
295173+
"status": "completed",
295174+
"started_at": "2024-10-07T02:47:00Z",
295175+
"completed_at": "2024-10-07T02:55:00Z",
295176+
"pattern_slug": "my-custom-pattern",
295177+
"pattern_scope": "enterprise"
295178+
},
295179+
{
295180+
"type": "git",
295181+
"status": "completed",
295182+
"started_at": "2024-10-07T02:47:00Z",
295183+
"completed_at": "2024-10-07T02:55:00Z",
295184+
"pattern_slug": "my-custom-pattern",
295185+
"pattern_scope": "organization"
295186+
}
295187+
]
295188+
}
295189+
},
295009295190
"repository-advisory": {
295010295191
"value": {
295011295192
"ghsa_id": "GHSA-abcd-1234-efgh",

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

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39154,6 +39154,42 @@ paths:
3915439154
githubCloudOnly: false
3915539155
category: secret-scanning
3915639156
subcategory: secret-scanning
39157+
"/repos/{owner}/{repo}/secret-scanning/scan-history":
39158+
get:
39159+
summary: Get secret scanning scan history for a repository
39160+
description: |-
39161+
Lists the latest incremental and backfill scans by type for a repository.
39162+
39163+
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.
39164+
tags:
39165+
- secret-scanning
39166+
operationId: secret-scanning/get-scan-history
39167+
externalDocs:
39168+
description: API method documentation
39169+
url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository
39170+
parameters:
39171+
- "$ref": "#/components/parameters/owner"
39172+
- "$ref": "#/components/parameters/repo"
39173+
responses:
39174+
'404':
39175+
description: Repository does not have GitHub Advanced Security or secret
39176+
scanning enabled
39177+
'503':
39178+
"$ref": "#/components/responses/service_unavailable"
39179+
'200':
39180+
description: Response
39181+
content:
39182+
application/json:
39183+
schema:
39184+
"$ref": "#/components/schemas/secret-scanning-scan-history"
39185+
examples:
39186+
default:
39187+
"$ref": "#/components/examples/secret-scanning-scan-history"
39188+
x-github:
39189+
githubCloudOnly: false
39190+
enabledForGitHubApps: true
39191+
category: secret-scanning
39192+
subcategory: secret-scanning
3915739193
"/repos/{owner}/{repo}/security-advisories":
3915839194
get:
3915939195
summary: List repository security advisories
@@ -89291,6 +89327,57 @@ components:
8929189327
token_type:
8929289328
type: string
8929389329
description: The token type this bypass is for.
89330+
secret-scanning-scan:
89331+
description: Information on a single scan performed by secret scanning on the
89332+
repository
89333+
type: object
89334+
properties:
89335+
type:
89336+
type: string
89337+
description: The type of scan
89338+
status:
89339+
type: string
89340+
description: The state of the scan. Either "completed" or "running"
89341+
completed_at:
89342+
type:
89343+
- string
89344+
- 'null'
89345+
format: date-time
89346+
description: The time that the scan was completed. Empty if the scan is
89347+
active
89348+
started_at:
89349+
type: string
89350+
format: date-time
89351+
description: The time that the scan was started
89352+
secret-scanning-scan-history:
89353+
type: object
89354+
properties:
89355+
incremental_scans:
89356+
type: array
89357+
items:
89358+
"$ref": "#/components/schemas/secret-scanning-scan"
89359+
pattern_update_scans:
89360+
type: array
89361+
items:
89362+
"$ref": "#/components/schemas/secret-scanning-scan"
89363+
backfill_scans:
89364+
type: array
89365+
items:
89366+
"$ref": "#/components/schemas/secret-scanning-scan"
89367+
custom_pattern_backfill_scans:
89368+
type: array
89369+
items:
89370+
allOf:
89371+
- "$ref": "#/components/schemas/secret-scanning-scan"
89372+
- type: object
89373+
properties:
89374+
pattern_name:
89375+
type: string
89376+
description: Name of the custom pattern for custom pattern scans
89377+
pattern_scope:
89378+
type: string
89379+
description: Level at which the custom pattern is defined, one of
89380+
"repository", "organization", or "enterprise"
8929489381
repository-advisory-create:
8929589382
type: object
8929689383
properties:
@@ -219982,6 +220069,43 @@ components:
219982220069
reason: will_fix_later
219983220070
expire_at: '2020-11-06T18:18:30Z'
219984220071
token_type: mailchimp_api_key
220072+
secret-scanning-scan-history:
220073+
value:
220074+
incremental_scans:
220075+
- type: git
220076+
status: completed
220077+
completed_at: '2024-10-07T02:47:00Z'
220078+
backfill_scans:
220079+
- type: git
220080+
status: completed
220081+
started_at: '2024-10-07T02:47:00Z'
220082+
completed_at: '2024-10-07T02:50:00Z'
220083+
- type: issue
220084+
status: completed
220085+
started_at: '2024-10-07T02:47:00Z'
220086+
completed_at: '2024-10-07T02:49:00Z'
220087+
- type: discussion
220088+
status: completed
220089+
started_at: '2024-10-07T02:47:00Z'
220090+
completed_at: '2024-10-07T02:48:00Z'
220091+
pattern_update_scans:
220092+
- type: discussion
220093+
status: in_progress
220094+
started_at: '2024-10-07T02:47:00Z'
220095+
completed_at: '2024-10-07T02:51:00Z'
220096+
custom_pattern_backfill_scans:
220097+
- type: git
220098+
status: completed
220099+
started_at: '2024-10-07T02:47:00Z'
220100+
completed_at: '2024-10-07T02:55:00Z'
220101+
pattern_slug: my-custom-pattern
220102+
pattern_scope: enterprise
220103+
- type: git
220104+
status: completed
220105+
started_at: '2024-10-07T02:47:00Z'
220106+
completed_at: '2024-10-07T02:55:00Z'
220107+
pattern_slug: my-custom-pattern
220108+
pattern_scope: organization
219985220109
repository-advisory:
219986220110
value:
219987220111
ghsa_id: GHSA-abcd-1234-efgh

0 commit comments

Comments
 (0)