Skip to content

Update OpenAPI 3.1 Descriptions #5001

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions descriptions-next/api.github.com/api.github.com.2022-11-28.json
Original file line number Diff line number Diff line change
Expand Up @@ -6335,15 +6335,15 @@
},
"/organizations/{org}/dependabot/repository-access": {
"get": {
"summary": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.",
"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.",
"summary": "Lists the repositories Dependabot can access in an organization",
"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.",
"tags": [
"dependabot"
],
"operationId": "dependabot/repository-access-for-org",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/dependabot/repository-access#lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies"
"url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization"
},
"parameters": [
{
Expand Down Expand Up @@ -6404,15 +6404,15 @@
}
},
"patch": {
"summary": "Updates repositories to the list of repositories that organization admins have allowed Dependabot to access when updating dependencies.",
"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```",
"summary": "Updates Dependabot's repository access list for an organization",
"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```",
"tags": [
"dependabot"
],
"operationId": "dependabot/update-repository-access-for-org",
"externalDocs": {
"description": "API method documentation",
"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"
"url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization"
},
"parameters": [
{
Expand Down Expand Up @@ -6498,7 +6498,7 @@
"/organizations/{org}/dependabot/repository-access/default-level": {
"put": {
"summary": "Set the default repository access level for Dependabot",
"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.",
"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.",
"tags": [
"dependabot"
],
Expand Down
17 changes: 9 additions & 8 deletions descriptions-next/api.github.com/api.github.com.2022-11-28.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4468,9 +4468,9 @@ paths:
subcategory: orgs
"/organizations/{org}/dependabot/repository-access":
get:
summary: Lists repositories that organization admins have allowed Dependabot
to access when updating dependencies.
summary: Lists the repositories Dependabot can access in an organization
description: |-
Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.
> [!NOTE]
> This operation supports both server-to-server and user-to-server access.
Unauthorized users will not see the existence of this endpoint.
Expand All @@ -4479,7 +4479,7 @@ paths:
operationId: dependabot/repository-access-for-org
externalDocs:
description: API method documentation
url: https://docs.github.com/rest/dependabot/repository-access#lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies
url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization
parameters:
- "$ref": "#/components/parameters/org"
- name: page
Expand Down Expand Up @@ -4519,9 +4519,10 @@ paths:
category: dependabot
subcategory: repository-access
patch:
summary: Updates repositories to the list of repositories that organization
admins have allowed Dependabot to access when updating dependencies.
summary: Updates Dependabot's repository access list for an organization
description: |-
Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.

> [!NOTE]
> This operation supports both server-to-server and user-to-server access.
Unauthorized users will not see the existence of this endpoint.
Expand All @@ -4538,7 +4539,7 @@ paths:
operationId: dependabot/update-repository-access-for-org
externalDocs:
description: API method documentation
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
url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization
parameters:
- "$ref": "#/components/parameters/org"
requestBody:
Expand Down Expand Up @@ -4594,13 +4595,13 @@ paths:
put:
summary: Set the default repository access level for Dependabot
description: |-
> [!NOTE]
> This operation supports both server-to-server and user-to-server access.
Sets the default level of repository access Dependabot will have while performing an update. Available values are:
- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.
- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.

Unauthorized users will not see the existence of this endpoint.

This operation supports both server-to-server and user-to-server access.
tags:
- dependabot
operationId: dependabot/set-repository-access-default-level
Expand Down
Loading