Skip to content

Commit bf4af7c

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #4884 from github/openapi-update-b1e20c9bcf96de764e3b81fa0db021943d9b43ef046b21e225cf9ebe49800df9
Update OpenAPI 3.1 Descriptions
2 parents 2133aef + 9e4c801 commit bf4af7c

24 files changed

+1244
-44
lines changed

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

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6379,6 +6379,81 @@
63796379
"category": "dependabot",
63806380
"subcategory": "repository-access"
63816381
}
6382+
},
6383+
"patch": {
6384+
"summary": "Updates repositories to the list of repositories that organization admins have allowed Dependabot to access when updating dependencies.",
6385+
"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.",
6386+
"tags": [
6387+
"dependabot"
6388+
],
6389+
"operationId": "dependabot/update-repository-access-for-org",
6390+
"externalDocs": {
6391+
"description": "API method documentation",
6392+
"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"
6393+
},
6394+
"parameters": [
6395+
{
6396+
"$ref": "#/components/parameters/org"
6397+
}
6398+
],
6399+
"requestBody": {
6400+
"required": true,
6401+
"content": {
6402+
"application/json": {
6403+
"schema": {
6404+
"type": "object",
6405+
"oneOf": [
6406+
{
6407+
"required": [
6408+
"repository_ids_to_add"
6409+
]
6410+
},
6411+
{
6412+
"required": [
6413+
"repository_ids_to_remove"
6414+
]
6415+
}
6416+
],
6417+
"properties": {
6418+
"repository_ids_to_add": {
6419+
"type": "array",
6420+
"items": {
6421+
"type": "integer"
6422+
}
6423+
},
6424+
"repository_ids_to_remove": {
6425+
"type": "array",
6426+
"items": {
6427+
"type": "integer"
6428+
}
6429+
}
6430+
}
6431+
},
6432+
"examples": {
6433+
"204": {
6434+
"summary": "Example with a 'succeeded' status."
6435+
}
6436+
}
6437+
}
6438+
}
6439+
},
6440+
"responses": {
6441+
"204": {
6442+
"description": "Response"
6443+
},
6444+
"403": {
6445+
"$ref": "#/components/responses/forbidden"
6446+
},
6447+
"404": {
6448+
"$ref": "#/components/responses/not_found"
6449+
}
6450+
},
6451+
"x-github": {
6452+
"githubCloudOnly": false,
6453+
"enabledForGitHubApps": true,
6454+
"category": "dependabot",
6455+
"subcategory": "repository-access"
6456+
}
63826457
}
63836458
},
63846459
"/organizations/{org}/dependabot/repository-access/default-level": {

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

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4500,6 +4500,56 @@ paths:
45004500
enabledForGitHubApps: true
45014501
category: dependabot
45024502
subcategory: repository-access
4503+
patch:
4504+
summary: Updates repositories to the list of repositories that organization
4505+
admins have allowed Dependabot to access when updating dependencies.
4506+
description: |-
4507+
> [!NOTE]
4508+
> This operation supports both server-to-server and user-to-server access.
4509+
Unauthorized users will not see the existence of this endpoint.
4510+
tags:
4511+
- dependabot
4512+
operationId: dependabot/update-repository-access-for-org
4513+
externalDocs:
4514+
description: API method documentation
4515+
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
4516+
parameters:
4517+
- "$ref": "#/components/parameters/org"
4518+
requestBody:
4519+
required: true
4520+
content:
4521+
application/json:
4522+
schema:
4523+
type: object
4524+
oneOf:
4525+
- required:
4526+
- repository_ids_to_add
4527+
- required:
4528+
- repository_ids_to_remove
4529+
properties:
4530+
repository_ids_to_add:
4531+
type: array
4532+
items:
4533+
type: integer
4534+
repository_ids_to_remove:
4535+
type: array
4536+
items:
4537+
type: integer
4538+
examples:
4539+
'204':
4540+
summary: Example with a 'succeeded' status.
4541+
responses:
4542+
'204':
4543+
description: Response
4544+
'403':
4545+
"$ref": "#/components/responses/forbidden"
4546+
'404':
4547+
"$ref": "#/components/responses/not_found"
4548+
x-github:
4549+
githubCloudOnly: false
4550+
enabledForGitHubApps: true
4551+
category: dependabot
4552+
subcategory: repository-access
45034553
"/organizations/{org}/dependabot/repository-access/default-level":
45044554
put:
45054555
summary: Set the default repository access level for Dependabot

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

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6379,6 +6379,81 @@
63796379
"category": "dependabot",
63806380
"subcategory": "repository-access"
63816381
}
6382+
},
6383+
"patch": {
6384+
"summary": "Updates repositories to the list of repositories that organization admins have allowed Dependabot to access when updating dependencies.",
6385+
"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.",
6386+
"tags": [
6387+
"dependabot"
6388+
],
6389+
"operationId": "dependabot/update-repository-access-for-org",
6390+
"externalDocs": {
6391+
"description": "API method documentation",
6392+
"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"
6393+
},
6394+
"parameters": [
6395+
{
6396+
"$ref": "#/components/parameters/org"
6397+
}
6398+
],
6399+
"requestBody": {
6400+
"required": true,
6401+
"content": {
6402+
"application/json": {
6403+
"schema": {
6404+
"type": "object",
6405+
"oneOf": [
6406+
{
6407+
"required": [
6408+
"repository_ids_to_add"
6409+
]
6410+
},
6411+
{
6412+
"required": [
6413+
"repository_ids_to_remove"
6414+
]
6415+
}
6416+
],
6417+
"properties": {
6418+
"repository_ids_to_add": {
6419+
"type": "array",
6420+
"items": {
6421+
"type": "integer"
6422+
}
6423+
},
6424+
"repository_ids_to_remove": {
6425+
"type": "array",
6426+
"items": {
6427+
"type": "integer"
6428+
}
6429+
}
6430+
}
6431+
},
6432+
"examples": {
6433+
"204": {
6434+
"summary": "Example with a 'succeeded' status."
6435+
}
6436+
}
6437+
}
6438+
}
6439+
},
6440+
"responses": {
6441+
"204": {
6442+
"description": "Response"
6443+
},
6444+
"403": {
6445+
"$ref": "#/components/responses/forbidden"
6446+
},
6447+
"404": {
6448+
"$ref": "#/components/responses/not_found"
6449+
}
6450+
},
6451+
"x-github": {
6452+
"githubCloudOnly": false,
6453+
"enabledForGitHubApps": true,
6454+
"category": "dependabot",
6455+
"subcategory": "repository-access"
6456+
}
63826457
}
63836458
},
63846459
"/organizations/{org}/dependabot/repository-access/default-level": {

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

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4500,6 +4500,56 @@ paths:
45004500
enabledForGitHubApps: true
45014501
category: dependabot
45024502
subcategory: repository-access
4503+
patch:
4504+
summary: Updates repositories to the list of repositories that organization
4505+
admins have allowed Dependabot to access when updating dependencies.
4506+
description: |-
4507+
> [!NOTE]
4508+
> This operation supports both server-to-server and user-to-server access.
4509+
Unauthorized users will not see the existence of this endpoint.
4510+
tags:
4511+
- dependabot
4512+
operationId: dependabot/update-repository-access-for-org
4513+
externalDocs:
4514+
description: API method documentation
4515+
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
4516+
parameters:
4517+
- "$ref": "#/components/parameters/org"
4518+
requestBody:
4519+
required: true
4520+
content:
4521+
application/json:
4522+
schema:
4523+
type: object
4524+
oneOf:
4525+
- required:
4526+
- repository_ids_to_add
4527+
- required:
4528+
- repository_ids_to_remove
4529+
properties:
4530+
repository_ids_to_add:
4531+
type: array
4532+
items:
4533+
type: integer
4534+
repository_ids_to_remove:
4535+
type: array
4536+
items:
4537+
type: integer
4538+
examples:
4539+
'204':
4540+
summary: Example with a 'succeeded' status.
4541+
responses:
4542+
'204':
4543+
description: Response
4544+
'403':
4545+
"$ref": "#/components/responses/forbidden"
4546+
'404':
4547+
"$ref": "#/components/responses/not_found"
4548+
x-github:
4549+
githubCloudOnly: false
4550+
enabledForGitHubApps: true
4551+
category: dependabot
4552+
subcategory: repository-access
45034553
"/organizations/{org}/dependabot/repository-access/default-level":
45044554
put:
45054555
summary: Set the default repository access level for Dependabot

0 commit comments

Comments
 (0)