Skip to content

Commit 90e0bcb

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #4784 from github/openapi-update-2da0f060e2608923e2e061a35651ba02365d1a4d91f67e509a2e9e28045933c4
Update OpenAPI 3.0 Descriptions
2 parents ada15ab + c131512 commit 90e0bcb

16 files changed

+4614
-3346
lines changed

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

Lines changed: 79 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,10 @@
180180
"name": "hosted-compute",
181181
"description": "Manage hosted compute networking resources."
182182
},
183+
{
184+
"name": "credentials",
185+
"description": "Revoke compromised or leaked GitHub credentials."
186+
},
183187
{
184188
"name": "campaigns",
185189
"description": "Endpoints to manage campaigns via the REST API."
@@ -2032,6 +2036,71 @@
20322036
}
20332037
}
20342038
},
2039+
"/credentials/revoke": {
2040+
"post": {
2041+
"summary": "Revoke a list of credentials",
2042+
"description": "Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation.\n\nThis endpoint currently accepts the following credential types:\n- Personal access tokens (classic)\n- Fine-grained personal access tokens\n\nRevoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users.\nGitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated.\n\nTo prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request.\n\n> [!NOTE]\n> Any authenticated requests will return a 403.",
2043+
"tags": [
2044+
"credentials"
2045+
],
2046+
"operationId": "credentials/revoke",
2047+
"externalDocs": {
2048+
"description": "API method documentation",
2049+
"url": "https://docs.github.com/rest/credentials/revoke#revoke-a-list-of-credentials"
2050+
},
2051+
"requestBody": {
2052+
"required": true,
2053+
"content": {
2054+
"application/json": {
2055+
"schema": {
2056+
"type": "object",
2057+
"properties": {
2058+
"credentials": {
2059+
"type": "array",
2060+
"description": "A list of credentials to be revoked, up to 1000 per request.",
2061+
"items": {
2062+
"type": "string"
2063+
},
2064+
"minItems": 1,
2065+
"maxItems": 1000
2066+
}
2067+
},
2068+
"required": [
2069+
"credentials"
2070+
]
2071+
},
2072+
"examples": {
2073+
"default": {
2074+
"value": {
2075+
"credentials": [
2076+
"ghp_1234567890abcdef1234567890abcdef12345678",
2077+
"ghp_abcdef1234567890abcdef1234567890abcdef12"
2078+
]
2079+
}
2080+
}
2081+
}
2082+
}
2083+
}
2084+
},
2085+
"responses": {
2086+
"202": {
2087+
"$ref": "#/components/responses/accepted"
2088+
},
2089+
"422": {
2090+
"$ref": "#/components/responses/validation_failed_simple"
2091+
},
2092+
"500": {
2093+
"$ref": "#/components/responses/internal_error"
2094+
}
2095+
},
2096+
"x-github": {
2097+
"githubCloudOnly": false,
2098+
"enabledForGitHubApps": false,
2099+
"category": "credentials",
2100+
"subcategory": "revoke"
2101+
}
2102+
}
2103+
},
20352104
"/emojis": {
20362105
"get": {
20372106
"summary": "Get emojis",
@@ -300936,6 +301005,16 @@
300936301005
}
300937301006
}
300938301007
},
301008+
"internal_error": {
301009+
"description": "Internal Error",
301010+
"content": {
301011+
"application/json": {
301012+
"schema": {
301013+
"$ref": "#/components/schemas/basic-error"
301014+
}
301015+
}
301016+
}
301017+
},
300939301018
"conflict": {
300940301019
"description": "Conflict",
300941301020
"content": {
@@ -301028,16 +301107,6 @@
301028301107
}
301029301108
}
301030301109
},
301031-
"internal_error": {
301032-
"description": "Internal Error",
301033-
"content": {
301034-
"application/json": {
301035-
"schema": {
301036-
"$ref": "#/components/schemas/basic-error"
301037-
}
301038-
}
301039-
}
301040-
},
301041301110
"actions_runner_jitconfig": {
301042301111
"description": "Response",
301043301112
"content": {

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

Lines changed: 66 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,8 @@ tags:
9595
description: Manage private registry configurations.
9696
- name: hosted-compute
9797
description: Manage hosted compute networking resources.
98+
- name: credentials
99+
description: Revoke compromised or leaked GitHub credentials.
98100
- name: campaigns
99101
description: Endpoints to manage campaigns via the REST API.
100102
servers:
@@ -1401,6 +1403,64 @@ paths:
14011403
enabledForGitHubApps: true
14021404
category: codes-of-conduct
14031405
subcategory: codes-of-conduct
1406+
"/credentials/revoke":
1407+
post:
1408+
summary: Revoke a list of credentials
1409+
description: |-
1410+
Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation.
1411+
1412+
This endpoint currently accepts the following credential types:
1413+
- Personal access tokens (classic)
1414+
- Fine-grained personal access tokens
1415+
1416+
Revoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users.
1417+
GitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated.
1418+
1419+
To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request.
1420+
1421+
> [!NOTE]
1422+
> Any authenticated requests will return a 403.
1423+
tags:
1424+
- credentials
1425+
operationId: credentials/revoke
1426+
externalDocs:
1427+
description: API method documentation
1428+
url: https://docs.github.com/rest/credentials/revoke#revoke-a-list-of-credentials
1429+
requestBody:
1430+
required: true
1431+
content:
1432+
application/json:
1433+
schema:
1434+
type: object
1435+
properties:
1436+
credentials:
1437+
type: array
1438+
description: A list of credentials to be revoked, up to 1000 per
1439+
request.
1440+
items:
1441+
type: string
1442+
minItems: 1
1443+
maxItems: 1000
1444+
required:
1445+
- credentials
1446+
examples:
1447+
default:
1448+
value:
1449+
credentials:
1450+
- ghp_1234567890abcdef1234567890abcdef12345678
1451+
- ghp_abcdef1234567890abcdef1234567890abcdef12
1452+
responses:
1453+
'202':
1454+
"$ref": "#/components/responses/accepted"
1455+
'422':
1456+
"$ref": "#/components/responses/validation_failed_simple"
1457+
'500':
1458+
"$ref": "#/components/responses/internal_error"
1459+
x-github:
1460+
githubCloudOnly: false
1461+
enabledForGitHubApps: false
1462+
category: credentials
1463+
subcategory: revoke
14041464
"/emojis":
14051465
get:
14061466
summary: Get emojis
@@ -228756,6 +228816,12 @@ components:
228756228816
application/json:
228757228817
schema:
228758228818
"$ref": "#/components/schemas/basic-error"
228819+
internal_error:
228820+
description: Internal Error
228821+
content:
228822+
application/json:
228823+
schema:
228824+
"$ref": "#/components/schemas/basic-error"
228759228825
conflict:
228760228826
description: Conflict
228761228827
content:
@@ -228813,12 +228879,6 @@ components:
228813228879
examples:
228814228880
default:
228815228881
"$ref": "#/components/examples/billing-usage-report"
228816-
internal_error:
228817-
description: Internal Error
228818-
content:
228819-
application/json:
228820-
schema:
228821-
"$ref": "#/components/schemas/basic-error"
228822228882
actions_runner_jitconfig:
228823228883
description: Response
228824228884
content:

‎descriptions/api.github.com/api.github.com.json‎

Lines changed: 79 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,10 @@
180180
"name": "hosted-compute",
181181
"description": "Manage hosted compute networking resources."
182182
},
183+
{
184+
"name": "credentials",
185+
"description": "Revoke compromised or leaked GitHub credentials."
186+
},
183187
{
184188
"name": "campaigns",
185189
"description": "Endpoints to manage campaigns via the REST API."
@@ -2032,6 +2036,71 @@
20322036
}
20332037
}
20342038
},
2039+
"/credentials/revoke": {
2040+
"post": {
2041+
"summary": "Revoke a list of credentials",
2042+
"description": "Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation.\n\nThis endpoint currently accepts the following credential types:\n- Personal access tokens (classic)\n- Fine-grained personal access tokens\n\nRevoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users.\nGitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated.\n\nTo prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request.\n\n> [!NOTE]\n> Any authenticated requests will return a 403.",
2043+
"tags": [
2044+
"credentials"
2045+
],
2046+
"operationId": "credentials/revoke",
2047+
"externalDocs": {
2048+
"description": "API method documentation",
2049+
"url": "https://docs.github.com/rest/credentials/revoke#revoke-a-list-of-credentials"
2050+
},
2051+
"requestBody": {
2052+
"required": true,
2053+
"content": {
2054+
"application/json": {
2055+
"schema": {
2056+
"type": "object",
2057+
"properties": {
2058+
"credentials": {
2059+
"type": "array",
2060+
"description": "A list of credentials to be revoked, up to 1000 per request.",
2061+
"items": {
2062+
"type": "string"
2063+
},
2064+
"minItems": 1,
2065+
"maxItems": 1000
2066+
}
2067+
},
2068+
"required": [
2069+
"credentials"
2070+
]
2071+
},
2072+
"examples": {
2073+
"default": {
2074+
"value": {
2075+
"credentials": [
2076+
"ghp_1234567890abcdef1234567890abcdef12345678",
2077+
"ghp_abcdef1234567890abcdef1234567890abcdef12"
2078+
]
2079+
}
2080+
}
2081+
}
2082+
}
2083+
}
2084+
},
2085+
"responses": {
2086+
"202": {
2087+
"$ref": "#/components/responses/accepted"
2088+
},
2089+
"422": {
2090+
"$ref": "#/components/responses/validation_failed_simple"
2091+
},
2092+
"500": {
2093+
"$ref": "#/components/responses/internal_error"
2094+
}
2095+
},
2096+
"x-github": {
2097+
"githubCloudOnly": false,
2098+
"enabledForGitHubApps": false,
2099+
"category": "credentials",
2100+
"subcategory": "revoke"
2101+
}
2102+
}
2103+
},
20352104
"/emojis": {
20362105
"get": {
20372106
"summary": "Get emojis",
@@ -300936,6 +301005,16 @@
300936301005
}
300937301006
}
300938301007
},
301008+
"internal_error": {
301009+
"description": "Internal Error",
301010+
"content": {
301011+
"application/json": {
301012+
"schema": {
301013+
"$ref": "#/components/schemas/basic-error"
301014+
}
301015+
}
301016+
}
301017+
},
300939301018
"conflict": {
300940301019
"description": "Conflict",
300941301020
"content": {
@@ -301028,16 +301107,6 @@
301028301107
}
301029301108
}
301030301109
},
301031-
"internal_error": {
301032-
"description": "Internal Error",
301033-
"content": {
301034-
"application/json": {
301035-
"schema": {
301036-
"$ref": "#/components/schemas/basic-error"
301037-
}
301038-
}
301039-
}
301040-
},
301041301110
"actions_runner_jitconfig": {
301042301111
"description": "Response",
301043301112
"content": {

0 commit comments

Comments
 (0)