Skip to content

Commit e7a314c

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #4785 from github/openapi-update-dfbe034f4a67edc03b2e5d4d74d046176a4ec175b68bb1e79ecafa2096b653c1
Update OpenAPI 3.1 Descriptions
2 parents 90e0bcb + 931b137 commit e7a314c

16 files changed

+4602
-3334
lines changed

‎descriptions-next/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."
@@ -2044,6 +2048,71 @@
20442048
}
20452049
}
20462050
},
2051+
"/credentials/revoke": {
2052+
"post": {
2053+
"summary": "Revoke a list of credentials",
2054+
"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.",
2055+
"tags": [
2056+
"credentials"
2057+
],
2058+
"operationId": "credentials/revoke",
2059+
"externalDocs": {
2060+
"description": "API method documentation",
2061+
"url": "https://docs.github.com/rest/credentials/revoke#revoke-a-list-of-credentials"
2062+
},
2063+
"requestBody": {
2064+
"required": true,
2065+
"content": {
2066+
"application/json": {
2067+
"schema": {
2068+
"type": "object",
2069+
"properties": {
2070+
"credentials": {
2071+
"type": "array",
2072+
"description": "A list of credentials to be revoked, up to 1000 per request.",
2073+
"items": {
2074+
"type": "string"
2075+
},
2076+
"minItems": 1,
2077+
"maxItems": 1000
2078+
}
2079+
},
2080+
"required": [
2081+
"credentials"
2082+
]
2083+
},
2084+
"examples": {
2085+
"default": {
2086+
"value": {
2087+
"credentials": [
2088+
"ghp_1234567890abcdef1234567890abcdef12345678",
2089+
"ghp_abcdef1234567890abcdef1234567890abcdef12"
2090+
]
2091+
}
2092+
}
2093+
}
2094+
}
2095+
}
2096+
},
2097+
"responses": {
2098+
"202": {
2099+
"$ref": "#/components/responses/accepted"
2100+
},
2101+
"422": {
2102+
"$ref": "#/components/responses/validation_failed_simple"
2103+
},
2104+
"500": {
2105+
"$ref": "#/components/responses/internal_error"
2106+
}
2107+
},
2108+
"x-github": {
2109+
"githubCloudOnly": false,
2110+
"enabledForGitHubApps": false,
2111+
"category": "credentials",
2112+
"subcategory": "revoke"
2113+
}
2114+
}
2115+
},
20472116
"/emojis": {
20482117
"get": {
20492118
"summary": "Get emojis",
@@ -309995,6 +310064,16 @@
309995310064
}
309996310065
}
309997310066
},
310067+
"internal_error": {
310068+
"description": "Internal Error",
310069+
"content": {
310070+
"application/json": {
310071+
"schema": {
310072+
"$ref": "#/components/schemas/basic-error"
310073+
}
310074+
}
310075+
}
310076+
},
309998310077
"conflict": {
309999310078
"description": "Conflict",
310000310079
"content": {
@@ -310089,16 +310168,6 @@
310089310168
}
310090310169
}
310091310170
},
310092-
"internal_error": {
310093-
"description": "Internal Error",
310094-
"content": {
310095-
"application/json": {
310096-
"schema": {
310097-
"$ref": "#/components/schemas/basic-error"
310098-
}
310099-
}
310100-
}
310101-
},
310102310171
"actions_runner_jitconfig": {
310103310172
"description": "Response",
310104310173
"content": {

‎descriptions-next/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:
@@ -1407,6 +1409,64 @@ paths:
14071409
enabledForGitHubApps: true
14081410
category: codes-of-conduct
14091411
subcategory: codes-of-conduct
1412+
"/credentials/revoke":
1413+
post:
1414+
summary: Revoke a list of credentials
1415+
description: |-
1416+
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.
1417+
1418+
This endpoint currently accepts the following credential types:
1419+
- Personal access tokens (classic)
1420+
- Fine-grained personal access tokens
1421+
1422+
Revoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users.
1423+
GitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated.
1424+
1425+
To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request.
1426+
1427+
> [!NOTE]
1428+
> Any authenticated requests will return a 403.
1429+
tags:
1430+
- credentials
1431+
operationId: credentials/revoke
1432+
externalDocs:
1433+
description: API method documentation
1434+
url: https://docs.github.com/rest/credentials/revoke#revoke-a-list-of-credentials
1435+
requestBody:
1436+
required: true
1437+
content:
1438+
application/json:
1439+
schema:
1440+
type: object
1441+
properties:
1442+
credentials:
1443+
type: array
1444+
description: A list of credentials to be revoked, up to 1000 per
1445+
request.
1446+
items:
1447+
type: string
1448+
minItems: 1
1449+
maxItems: 1000
1450+
required:
1451+
- credentials
1452+
examples:
1453+
default:
1454+
value:
1455+
credentials:
1456+
- ghp_1234567890abcdef1234567890abcdef12345678
1457+
- ghp_abcdef1234567890abcdef1234567890abcdef12
1458+
responses:
1459+
'202':
1460+
"$ref": "#/components/responses/accepted"
1461+
'422':
1462+
"$ref": "#/components/responses/validation_failed_simple"
1463+
'500':
1464+
"$ref": "#/components/responses/internal_error"
1465+
x-github:
1466+
githubCloudOnly: false
1467+
enabledForGitHubApps: false
1468+
category: credentials
1469+
subcategory: revoke
14101470
"/emojis":
14111471
get:
14121472
summary: Get emojis
@@ -232243,6 +232303,12 @@ components:
232243232303
application/json:
232244232304
schema:
232245232305
"$ref": "#/components/schemas/basic-error"
232306+
internal_error:
232307+
description: Internal Error
232308+
content:
232309+
application/json:
232310+
schema:
232311+
"$ref": "#/components/schemas/basic-error"
232246232312
conflict:
232247232313
description: Conflict
232248232314
content:
@@ -232301,12 +232367,6 @@ components:
232301232367
examples:
232302232368
default:
232303232369
"$ref": "#/components/examples/billing-usage-report"
232304-
internal_error:
232305-
description: Internal Error
232306-
content:
232307-
application/json:
232308-
schema:
232309-
"$ref": "#/components/schemas/basic-error"
232310232370
actions_runner_jitconfig:
232311232371
description: Response
232312232372
content:

‎descriptions-next/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."
@@ -2044,6 +2048,71 @@
20442048
}
20452049
}
20462050
},
2051+
"/credentials/revoke": {
2052+
"post": {
2053+
"summary": "Revoke a list of credentials",
2054+
"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.",
2055+
"tags": [
2056+
"credentials"
2057+
],
2058+
"operationId": "credentials/revoke",
2059+
"externalDocs": {
2060+
"description": "API method documentation",
2061+
"url": "https://docs.github.com/rest/credentials/revoke#revoke-a-list-of-credentials"
2062+
},
2063+
"requestBody": {
2064+
"required": true,
2065+
"content": {
2066+
"application/json": {
2067+
"schema": {
2068+
"type": "object",
2069+
"properties": {
2070+
"credentials": {
2071+
"type": "array",
2072+
"description": "A list of credentials to be revoked, up to 1000 per request.",
2073+
"items": {
2074+
"type": "string"
2075+
},
2076+
"minItems": 1,
2077+
"maxItems": 1000
2078+
}
2079+
},
2080+
"required": [
2081+
"credentials"
2082+
]
2083+
},
2084+
"examples": {
2085+
"default": {
2086+
"value": {
2087+
"credentials": [
2088+
"ghp_1234567890abcdef1234567890abcdef12345678",
2089+
"ghp_abcdef1234567890abcdef1234567890abcdef12"
2090+
]
2091+
}
2092+
}
2093+
}
2094+
}
2095+
}
2096+
},
2097+
"responses": {
2098+
"202": {
2099+
"$ref": "#/components/responses/accepted"
2100+
},
2101+
"422": {
2102+
"$ref": "#/components/responses/validation_failed_simple"
2103+
},
2104+
"500": {
2105+
"$ref": "#/components/responses/internal_error"
2106+
}
2107+
},
2108+
"x-github": {
2109+
"githubCloudOnly": false,
2110+
"enabledForGitHubApps": false,
2111+
"category": "credentials",
2112+
"subcategory": "revoke"
2113+
}
2114+
}
2115+
},
20472116
"/emojis": {
20482117
"get": {
20492118
"summary": "Get emojis",
@@ -309995,6 +310064,16 @@
309995310064
}
309996310065
}
309997310066
},
310067+
"internal_error": {
310068+
"description": "Internal Error",
310069+
"content": {
310070+
"application/json": {
310071+
"schema": {
310072+
"$ref": "#/components/schemas/basic-error"
310073+
}
310074+
}
310075+
}
310076+
},
309998310077
"conflict": {
309999310078
"description": "Conflict",
310000310079
"content": {
@@ -310089,16 +310168,6 @@
310089310168
}
310090310169
}
310091310170
},
310092-
"internal_error": {
310093-
"description": "Internal Error",
310094-
"content": {
310095-
"application/json": {
310096-
"schema": {
310097-
"$ref": "#/components/schemas/basic-error"
310098-
}
310099-
}
310100-
}
310101-
},
310102310171
"actions_runner_jitconfig": {
310103310172
"description": "Response",
310104310173
"content": {

0 commit comments

Comments
 (0)