From 45b3ca2aee8b940b785ef788572416118b5b644c Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Tue, 1 Apr 2025 21:57:39 -0700 Subject: [PATCH] Update OpenAPI Description (#55098) Co-authored-by: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com> --- src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 2 +- src/rest/data/ghec-2022-11-28/schema.json | 2 +- src/rest/data/ghes-3.12-2022-11-28/schema.json | 2 +- src/rest/data/ghes-3.13-2022-11-28/schema.json | 2 +- src/rest/data/ghes-3.14-2022-11-28/schema.json | 2 +- src/rest/data/ghes-3.15-2022-11-28/schema.json | 2 +- src/rest/data/ghes-3.16-2022-11-28/schema.json | 2 +- src/rest/lib/config.json | 2 +- src/webhooks/lib/config.json | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 0c0a55874b15..6d7a6cfb04f0 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "87477e51bc28423c080137f93c1d646251157b74" + "sha": "7ef76f8a5d8a0645e8b78a367648350624c0ef5f" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 0e69cc467bfa..885933610ac9 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -218197,7 +218197,7 @@ } ], "previews": [], - "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n\n

Removing a user as a collaborator has the following effects on forks:

\n\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", + "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n\n

Removing a user as a collaborator has the following effects on forks:

\n\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", "statusCodes": [ { "httpStatusCode": "204", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 2e802554595d..3904f845d9c7 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -229496,7 +229496,7 @@ } ], "previews": [], - "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n\n

Removing a user as a collaborator has the following effects on forks:

\n\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", + "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n\n

Removing a user as a collaborator has the following effects on forks:

\n\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", "statusCodes": [ { "httpStatusCode": "204", diff --git a/src/rest/data/ghes-3.12-2022-11-28/schema.json b/src/rest/data/ghes-3.12-2022-11-28/schema.json index 7667793ca649..1498e97c7762 100644 --- a/src/rest/data/ghes-3.12-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.12-2022-11-28/schema.json @@ -160760,7 +160760,7 @@ } ], "previews": [], - "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n\n

Removing a user as a collaborator has the following effects on forks:

\n\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", + "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n\n

Removing a user as a collaborator has the following effects on forks:

\n\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", "statusCodes": [ { "httpStatusCode": "204", diff --git a/src/rest/data/ghes-3.13-2022-11-28/schema.json b/src/rest/data/ghes-3.13-2022-11-28/schema.json index 88ba8c8a9c3c..79ff4fe2cdd4 100644 --- a/src/rest/data/ghes-3.13-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.13-2022-11-28/schema.json @@ -160904,7 +160904,7 @@ } ], "previews": [], - "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n\n

Removing a user as a collaborator has the following effects on forks:

\n\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", + "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n\n

Removing a user as a collaborator has the following effects on forks:

\n\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", "statusCodes": [ { "httpStatusCode": "204", diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index 628d146c922d..c20a462db6e8 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -160904,7 +160904,7 @@ } ], "previews": [], - "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n\n

Removing a user as a collaborator has the following effects on forks:

\n\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", + "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n\n

Removing a user as a collaborator has the following effects on forks:

\n\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", "statusCodes": [ { "httpStatusCode": "204", diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index f56db6e25273..b89a74e89140 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -165031,7 +165031,7 @@ } ], "previews": [], - "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n\n

Removing a user as a collaborator has the following effects on forks:

\n\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", + "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n\n

Removing a user as a collaborator has the following effects on forks:

\n\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", "statusCodes": [ { "httpStatusCode": "204", diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index 3a99525e03ac..9bb03058d0c2 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -168681,7 +168681,7 @@ } ], "previews": [], - "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n\n

Removing a user as a collaborator has the following effects on forks:

\n\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", + "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n\n

Removing a user as a collaborator has the following effects on forks:

\n\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", "statusCodes": [ { "httpStatusCode": "204", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 6b1de0f62100..64acd3b140a5 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -47,5 +47,5 @@ ] } }, - "sha": "87477e51bc28423c080137f93c1d646251157b74" + "sha": "7ef76f8a5d8a0645e8b78a367648350624c0ef5f" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 737a2ed3c94c..069d4000d541 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "87477e51bc28423c080137f93c1d646251157b74" + "sha": "7ef76f8a5d8a0645e8b78a367648350624c0ef5f" } \ No newline at end of file