Skip to content

Commit 7a1171b

Browse files
Update OpenAPI 3.1 Descriptions
1 parent 042ebdf commit 7a1171b

16 files changed

+13630
-10550
lines changed

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6335,15 +6335,15 @@
63356335
},
63366336
"/organizations/{org}/dependabot/repository-access": {
63376337
"get": {
6338-
"summary": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.",
6339-
"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.",
6338+
"summary": "Lists the repositories Dependabot can access in an organization",
6339+
"description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.",
63406340
"tags": [
63416341
"dependabot"
63426342
],
63436343
"operationId": "dependabot/repository-access-for-org",
63446344
"externalDocs": {
63456345
"description": "API method documentation",
6346-
"url": "https://docs.github.com/rest/dependabot/repository-access#lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies"
6346+
"url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization"
63476347
},
63486348
"parameters": [
63496349
{
@@ -6404,15 +6404,15 @@
64046404
}
64056405
},
64066406
"patch": {
6407-
"summary": "Updates repositories to the list of repositories that organization admins have allowed Dependabot to access when updating dependencies.",
6408-
"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.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```",
6407+
"summary": "Updates Dependabot's repository access list for an organization",
6408+
"description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```",
64096409
"tags": [
64106410
"dependabot"
64116411
],
64126412
"operationId": "dependabot/update-repository-access-for-org",
64136413
"externalDocs": {
64146414
"description": "API method documentation",
6415-
"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"
6415+
"url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization"
64166416
},
64176417
"parameters": [
64186418
{
@@ -6498,7 +6498,7 @@
64986498
"/organizations/{org}/dependabot/repository-access/default-level": {
64996499
"put": {
65006500
"summary": "Set the default repository access level for Dependabot",
6501-
"description": "> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nSets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.",
6501+
"description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.",
65026502
"tags": [
65036503
"dependabot"
65046504
],

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

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4468,9 +4468,9 @@ paths:
44684468
subcategory: orgs
44694469
"/organizations/{org}/dependabot/repository-access":
44704470
get:
4471-
summary: Lists repositories that organization admins have allowed Dependabot
4472-
to access when updating dependencies.
4471+
summary: Lists the repositories Dependabot can access in an organization
44734472
description: |-
4473+
Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.
44744474
> [!NOTE]
44754475
> This operation supports both server-to-server and user-to-server access.
44764476
Unauthorized users will not see the existence of this endpoint.
@@ -4479,7 +4479,7 @@ paths:
44794479
operationId: dependabot/repository-access-for-org
44804480
externalDocs:
44814481
description: API method documentation
4482-
url: https://docs.github.com/rest/dependabot/repository-access#lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies
4482+
url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization
44834483
parameters:
44844484
- "$ref": "#/components/parameters/org"
44854485
- name: page
@@ -4519,9 +4519,10 @@ paths:
45194519
category: dependabot
45204520
subcategory: repository-access
45214521
patch:
4522-
summary: Updates repositories to the list of repositories that organization
4523-
admins have allowed Dependabot to access when updating dependencies.
4522+
summary: Updates Dependabot's repository access list for an organization
45244523
description: |-
4524+
Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.
4525+
45254526
> [!NOTE]
45264527
> This operation supports both server-to-server and user-to-server access.
45274528
Unauthorized users will not see the existence of this endpoint.
@@ -4538,7 +4539,7 @@ paths:
45384539
operationId: dependabot/update-repository-access-for-org
45394540
externalDocs:
45404541
description: API method documentation
4541-
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
4542+
url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization
45424543
parameters:
45434544
- "$ref": "#/components/parameters/org"
45444545
requestBody:
@@ -4594,13 +4595,13 @@ paths:
45944595
put:
45954596
summary: Set the default repository access level for Dependabot
45964597
description: |-
4597-
> [!NOTE]
4598-
> This operation supports both server-to-server and user-to-server access.
45994598
Sets the default level of repository access Dependabot will have while performing an update. Available values are:
46004599
- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.
46014600
- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.
46024601

46034602
Unauthorized users will not see the existence of this endpoint.
4603+
4604+
This operation supports both server-to-server and user-to-server access.
46044605
tags:
46054606
- dependabot
46064607
operationId: dependabot/set-repository-access-default-level

0 commit comments

Comments
 (0)