Skip to content

Commit 2133aef

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #4883 from github/openapi-update-d3426691c1814f6f9091f2a94029e40a1d56f9ec541e8bd43f8156d229b081bf
Update OpenAPI 3.0 Descriptions
2 parents 31cc3f6 + 938f35f commit 2133aef

24 files changed

Lines changed: 1244 additions & 44 deletions

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

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6341,6 +6341,81 @@
63416341
"category": "dependabot",
63426342
"subcategory": "repository-access"
63436343
}
6344+
},
6345+
"patch": {
6346+
"summary": "Updates repositories to the list of repositories that organization admins have allowed Dependabot to access when updating dependencies.",
6347+
"description": "> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.",
6348+
"tags": [
6349+
"dependabot"
6350+
],
6351+
"operationId": "dependabot/update-repository-access-for-org",
6352+
"externalDocs": {
6353+
"description": "API method documentation",
6354+
"url": "https://docs.github.com/rest/dependabot/repository-access#updates-repositories-to-the-list-of-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies"
6355+
},
6356+
"parameters": [
6357+
{
6358+
"$ref": "#/components/parameters/org"
6359+
}
6360+
],
6361+
"requestBody": {
6362+
"required": true,
6363+
"content": {
6364+
"application/json": {
6365+
"schema": {
6366+
"type": "object",
6367+
"oneOf": [
6368+
{
6369+
"required": [
6370+
"repository_ids_to_add"
6371+
]
6372+
},
6373+
{
6374+
"required": [
6375+
"repository_ids_to_remove"
6376+
]
6377+
}
6378+
],
6379+
"properties": {
6380+
"repository_ids_to_add": {
6381+
"type": "array",
6382+
"items": {
6383+
"type": "integer"
6384+
}
6385+
},
6386+
"repository_ids_to_remove": {
6387+
"type": "array",
6388+
"items": {
6389+
"type": "integer"
6390+
}
6391+
}
6392+
}
6393+
},
6394+
"examples": {
6395+
"204": {
6396+
"summary": "Example with a 'succeeded' status."
6397+
}
6398+
}
6399+
}
6400+
}
6401+
},
6402+
"responses": {
6403+
"204": {
6404+
"description": "Response"
6405+
},
6406+
"403": {
6407+
"$ref": "#/components/responses/forbidden"
6408+
},
6409+
"404": {
6410+
"$ref": "#/components/responses/not_found"
6411+
}
6412+
},
6413+
"x-github": {
6414+
"githubCloudOnly": false,
6415+
"enabledForGitHubApps": true,
6416+
"category": "dependabot",
6417+
"subcategory": "repository-access"
6418+
}
63446419
}
63456420
},
63466421
"/organizations/{org}/dependabot/repository-access/default-level": {

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

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4483,6 +4483,56 @@ paths:
44834483
enabledForGitHubApps: true
44844484
category: dependabot
44854485
subcategory: repository-access
4486+
patch:
4487+
summary: Updates repositories to the list of repositories that organization
4488+
admins have allowed Dependabot to access when updating dependencies.
4489+
description: |-
4490+
> [!NOTE]
4491+
> This operation supports both server-to-server and user-to-server access.
4492+
Unauthorized users will not see the existence of this endpoint.
4493+
tags:
4494+
- dependabot
4495+
operationId: dependabot/update-repository-access-for-org
4496+
externalDocs:
4497+
description: API method documentation
4498+
url: https://docs.github.com/rest/dependabot/repository-access#updates-repositories-to-the-list-of-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies
4499+
parameters:
4500+
- "$ref": "#/components/parameters/org"
4501+
requestBody:
4502+
required: true
4503+
content:
4504+
application/json:
4505+
schema:
4506+
type: object
4507+
oneOf:
4508+
- required:
4509+
- repository_ids_to_add
4510+
- required:
4511+
- repository_ids_to_remove
4512+
properties:
4513+
repository_ids_to_add:
4514+
type: array
4515+
items:
4516+
type: integer
4517+
repository_ids_to_remove:
4518+
type: array
4519+
items:
4520+
type: integer
4521+
examples:
4522+
'204':
4523+
summary: Example with a 'succeeded' status.
4524+
responses:
4525+
'204':
4526+
description: Response
4527+
'403':
4528+
"$ref": "#/components/responses/forbidden"
4529+
'404':
4530+
"$ref": "#/components/responses/not_found"
4531+
x-github:
4532+
githubCloudOnly: false
4533+
enabledForGitHubApps: true
4534+
category: dependabot
4535+
subcategory: repository-access
44864536
"/organizations/{org}/dependabot/repository-access/default-level":
44874537
put:
44884538
summary: Set the default repository access level for Dependabot

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

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6341,6 +6341,81 @@
63416341
"category": "dependabot",
63426342
"subcategory": "repository-access"
63436343
}
6344+
},
6345+
"patch": {
6346+
"summary": "Updates repositories to the list of repositories that organization admins have allowed Dependabot to access when updating dependencies.",
6347+
"description": "> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.",
6348+
"tags": [
6349+
"dependabot"
6350+
],
6351+
"operationId": "dependabot/update-repository-access-for-org",
6352+
"externalDocs": {
6353+
"description": "API method documentation",
6354+
"url": "https://docs.github.com/rest/dependabot/repository-access#updates-repositories-to-the-list-of-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies"
6355+
},
6356+
"parameters": [
6357+
{
6358+
"$ref": "#/components/parameters/org"
6359+
}
6360+
],
6361+
"requestBody": {
6362+
"required": true,
6363+
"content": {
6364+
"application/json": {
6365+
"schema": {
6366+
"type": "object",
6367+
"oneOf": [
6368+
{
6369+
"required": [
6370+
"repository_ids_to_add"
6371+
]
6372+
},
6373+
{
6374+
"required": [
6375+
"repository_ids_to_remove"
6376+
]
6377+
}
6378+
],
6379+
"properties": {
6380+
"repository_ids_to_add": {
6381+
"type": "array",
6382+
"items": {
6383+
"type": "integer"
6384+
}
6385+
},
6386+
"repository_ids_to_remove": {
6387+
"type": "array",
6388+
"items": {
6389+
"type": "integer"
6390+
}
6391+
}
6392+
}
6393+
},
6394+
"examples": {
6395+
"204": {
6396+
"summary": "Example with a 'succeeded' status."
6397+
}
6398+
}
6399+
}
6400+
}
6401+
},
6402+
"responses": {
6403+
"204": {
6404+
"description": "Response"
6405+
},
6406+
"403": {
6407+
"$ref": "#/components/responses/forbidden"
6408+
},
6409+
"404": {
6410+
"$ref": "#/components/responses/not_found"
6411+
}
6412+
},
6413+
"x-github": {
6414+
"githubCloudOnly": false,
6415+
"enabledForGitHubApps": true,
6416+
"category": "dependabot",
6417+
"subcategory": "repository-access"
6418+
}
63446419
}
63456420
},
63466421
"/organizations/{org}/dependabot/repository-access/default-level": {

‎descriptions/api.github.com/api.github.com.yaml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4483,6 +4483,56 @@ paths:
44834483
enabledForGitHubApps: true
44844484
category: dependabot
44854485
subcategory: repository-access
4486+
patch:
4487+
summary: Updates repositories to the list of repositories that organization
4488+
admins have allowed Dependabot to access when updating dependencies.
4489+
description: |-
4490+
> [!NOTE]
4491+
> This operation supports both server-to-server and user-to-server access.
4492+
Unauthorized users will not see the existence of this endpoint.
4493+
tags:
4494+
- dependabot
4495+
operationId: dependabot/update-repository-access-for-org
4496+
externalDocs:
4497+
description: API method documentation
4498+
url: https://docs.github.com/rest/dependabot/repository-access#updates-repositories-to-the-list-of-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies
4499+
parameters:
4500+
- "$ref": "#/components/parameters/org"
4501+
requestBody:
4502+
required: true
4503+
content:
4504+
application/json:
4505+
schema:
4506+
type: object
4507+
oneOf:
4508+
- required:
4509+
- repository_ids_to_add
4510+
- required:
4511+
- repository_ids_to_remove
4512+
properties:
4513+
repository_ids_to_add:
4514+
type: array
4515+
items:
4516+
type: integer
4517+
repository_ids_to_remove:
4518+
type: array
4519+
items:
4520+
type: integer
4521+
examples:
4522+
'204':
4523+
summary: Example with a 'succeeded' status.
4524+
responses:
4525+
'204':
4526+
description: Response
4527+
'403':
4528+
"$ref": "#/components/responses/forbidden"
4529+
'404':
4530+
"$ref": "#/components/responses/not_found"
4531+
x-github:
4532+
githubCloudOnly: false
4533+
enabledForGitHubApps: true
4534+
category: dependabot
4535+
subcategory: repository-access
44864536
"/organizations/{org}/dependabot/repository-access/default-level":
44874537
put:
44884538
summary: Set the default repository access level for Dependabot

0 commit comments

Comments
 (0)