Skip to content

Commit 759a2a0

Browse files
authored
Merge pull request #5000 from github/openapi-update-e95b7edc4744a16a2fe8b2ed2d7034b314893440c2d00265f16a75984e953b82
Update OpenAPI 3.0 Descriptions
2 parents 042ebdf + 15dddde commit 759a2a0

16 files changed

+13806
-10774
lines changed

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6297,15 +6297,15 @@
62976297
},
62986298
"/organizations/{org}/dependabot/repository-access": {
62996299
"get": {
6300-
"summary": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.",
6301-
"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.",
6300+
"summary": "Lists the repositories Dependabot can access in an organization",
6301+
"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.",
63026302
"tags": [
63036303
"dependabot"
63046304
],
63056305
"operationId": "dependabot/repository-access-for-org",
63066306
"externalDocs": {
63076307
"description": "API method documentation",
6308-
"url": "https://docs.github.com/rest/dependabot/repository-access#lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies"
6308+
"url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization"
63096309
},
63106310
"parameters": [
63116311
{
@@ -6366,15 +6366,15 @@
63666366
}
63676367
},
63686368
"patch": {
6369-
"summary": "Updates repositories to the list of repositories that organization admins have allowed Dependabot to access when updating dependencies.",
6370-
"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```",
6369+
"summary": "Updates Dependabot's repository access list for an organization",
6370+
"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```",
63716371
"tags": [
63726372
"dependabot"
63736373
],
63746374
"operationId": "dependabot/update-repository-access-for-org",
63756375
"externalDocs": {
63766376
"description": "API method documentation",
6377-
"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"
6377+
"url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization"
63786378
},
63796379
"parameters": [
63806380
{
@@ -6460,7 +6460,7 @@
64606460
"/organizations/{org}/dependabot/repository-access/default-level": {
64616461
"put": {
64626462
"summary": "Set the default repository access level for Dependabot",
6463-
"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.",
6463+
"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.",
64646464
"tags": [
64656465
"dependabot"
64666466
],

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

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4451,9 +4451,9 @@ paths:
44514451
subcategory: orgs
44524452
"/organizations/{org}/dependabot/repository-access":
44534453
get:
4454-
summary: Lists repositories that organization admins have allowed Dependabot
4455-
to access when updating dependencies.
4454+
summary: Lists the repositories Dependabot can access in an organization
44564455
description: |-
4456+
Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.
44574457
> [!NOTE]
44584458
> This operation supports both server-to-server and user-to-server access.
44594459
Unauthorized users will not see the existence of this endpoint.
@@ -4462,7 +4462,7 @@ paths:
44624462
operationId: dependabot/repository-access-for-org
44634463
externalDocs:
44644464
description: API method documentation
4465-
url: https://docs.github.com/rest/dependabot/repository-access#lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies
4465+
url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization
44664466
parameters:
44674467
- "$ref": "#/components/parameters/org"
44684468
- name: page
@@ -4502,9 +4502,10 @@ paths:
45024502
category: dependabot
45034503
subcategory: repository-access
45044504
patch:
4505-
summary: Updates repositories to the list of repositories that organization
4506-
admins have allowed Dependabot to access when updating dependencies.
4505+
summary: Updates Dependabot's repository access list for an organization
45074506
description: |-
4507+
Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.
4508+
45084509
> [!NOTE]
45094510
> This operation supports both server-to-server and user-to-server access.
45104511
Unauthorized users will not see the existence of this endpoint.
@@ -4521,7 +4522,7 @@ paths:
45214522
operationId: dependabot/update-repository-access-for-org
45224523
externalDocs:
45234524
description: API method documentation
4524-
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
4525+
url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization
45254526
parameters:
45264527
- "$ref": "#/components/parameters/org"
45274528
requestBody:
@@ -4577,13 +4578,13 @@ paths:
45774578
put:
45784579
summary: Set the default repository access level for Dependabot
45794580
description: |-
4580-
> [!NOTE]
4581-
> This operation supports both server-to-server and user-to-server access.
45824581
Sets the default level of repository access Dependabot will have while performing an update. Available values are:
45834582
- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.
45844583
- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.
45854584

45864585
Unauthorized users will not see the existence of this endpoint.
4586+
4587+
This operation supports both server-to-server and user-to-server access.
45874588
tags:
45884589
- dependabot
45894590
operationId: dependabot/set-repository-access-default-level

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6297,15 +6297,15 @@
62976297
},
62986298
"/organizations/{org}/dependabot/repository-access": {
62996299
"get": {
6300-
"summary": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.",
6301-
"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.",
6300+
"summary": "Lists the repositories Dependabot can access in an organization",
6301+
"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.",
63026302
"tags": [
63036303
"dependabot"
63046304
],
63056305
"operationId": "dependabot/repository-access-for-org",
63066306
"externalDocs": {
63076307
"description": "API method documentation",
6308-
"url": "https://docs.github.com/rest/dependabot/repository-access#lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies"
6308+
"url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization"
63096309
},
63106310
"parameters": [
63116311
{
@@ -6366,15 +6366,15 @@
63666366
}
63676367
},
63686368
"patch": {
6369-
"summary": "Updates repositories to the list of repositories that organization admins have allowed Dependabot to access when updating dependencies.",
6370-
"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```",
6369+
"summary": "Updates Dependabot's repository access list for an organization",
6370+
"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```",
63716371
"tags": [
63726372
"dependabot"
63736373
],
63746374
"operationId": "dependabot/update-repository-access-for-org",
63756375
"externalDocs": {
63766376
"description": "API method documentation",
6377-
"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"
6377+
"url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization"
63786378
},
63796379
"parameters": [
63806380
{
@@ -6460,7 +6460,7 @@
64606460
"/organizations/{org}/dependabot/repository-access/default-level": {
64616461
"put": {
64626462
"summary": "Set the default repository access level for Dependabot",
6463-
"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.",
6463+
"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.",
64646464
"tags": [
64656465
"dependabot"
64666466
],

0 commit comments

Comments
 (0)