diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 3bc023f6bad8..f719dfb50eab 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -576,13 +576,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -1491,13 +1491,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists the GitHub Actions caches for a repository.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists the GitHub Actions caches for a repository.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -4484,13 +4484,13 @@ } ], "previews": [], - "descriptionHTML": "

Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -9475,13 +9475,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -89643,13 +89643,13 @@ } ], "previews": [], - "descriptionHTML": "

This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.

" }, { "serverUrl": "https://api.github.com", @@ -113112,13 +113112,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the summary of the free and paid GitHub Actions minutes used.

\n

Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the summary of the free and paid GitHub Actions minutes used.

\n

Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -180884,7 +180884,6 @@ } ], "previews": [], - "descriptionHTML": "

Sets a code security configuration as a default to be applied to new repositories in your enterprise.

\n

This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set.

\n

The authenticated user must be an administrator for the enterprise to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -180898,7 +180897,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Sets a code security configuration as a default to be applied to new repositories in your enterprise.

\n

This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set.

\n

The authenticated user must be an administrator for the enterprise to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -186235,7 +186235,6 @@ } ], "previews": [], - "descriptionHTML": "

Returns array of all GitHub's codes of conduct.

", "statusCodes": [ { "httpStatusCode": "200", @@ -186245,7 +186244,8 @@ "httpStatusCode": "304", "description": "

Not modified

" } - ] + ], + "descriptionHTML": "

Returns array of all GitHub's codes of conduct.

" }, { "serverUrl": "https://api.github.com", @@ -223936,13 +223936,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all development environment secrets available in a repository without revealing their encrypted\nvalues.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all development environment secrets available in a repository without revealing their encrypted\nvalues.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -268991,13 +268991,13 @@ } ], "previews": [], - "descriptionHTML": "

Enable a custom deployment protection rule for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

The enabled custom deployment protection rule

" } - ] + ], + "descriptionHTML": "

Enable a custom deployment protection rule for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -271153,7 +271153,6 @@ } ], "previews": [], - "descriptionHTML": "

Users with push access can create deployment statuses for a given deployment.

\n

OAuth app tokens and personal access tokens (classic) need the repo_deployment scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", @@ -271163,7 +271162,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Users with push access can create deployment statuses for a given deployment.

\n

OAuth app tokens and personal access tokens (classic) need the repo_deployment scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -275262,13 +275262,13 @@ } ], "previews": [], - "descriptionHTML": "

Add multiple team members to an enterprise team.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

Successfully added team members.

" } - ] + ], + "descriptionHTML": "

Add multiple team members to an enterprise team.

" }, { "serverUrl": "https://api.github.com", @@ -292182,7 +292182,6 @@ } ], "previews": [], - "descriptionHTML": "

Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.

", "statusCodes": [ { "httpStatusCode": "201", @@ -292196,7 +292195,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.

" }, { "serverUrl": "https://api.github.com", @@ -293687,7 +293687,6 @@ } ], "previews": [], - "descriptionHTML": "

Get the content of a gitignore template.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -293697,7 +293696,8 @@ "httpStatusCode": "304", "description": "

Not modified

" } - ] + ], + "descriptionHTML": "

Get the content of a gitignore template.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n" } ] }, @@ -364960,13 +364960,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists labels for issues in a milestone.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists labels for issues in a milestone.

" } ], "milestones": [ @@ -401197,13 +401197,13 @@ } ], "previews": [], - "descriptionHTML": "

Get Hypermedia links to resources accessible in GitHub's REST API

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Get Hypermedia links to resources accessible in GitHub's REST API

" }, { "serverUrl": "https://api.github.com", @@ -402131,13 +402131,13 @@ } ], "previews": [], - "descriptionHTML": "

Returns all community profile metrics for a repository. The repository cannot be a fork.

\n

The returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.

\n

The health_percentage score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"About community profiles for public repositories.\"

\n

content_reports_enabled is only returned for organization-owned repositories.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Returns all community profile metrics for a repository. The repository cannot be a fork.

\n

The returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.

\n

The health_percentage score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"About community profiles for public repositories.\"

\n

content_reports_enabled is only returned for organization-owned repositories.

" } ], "statistics": [ @@ -403708,7 +403708,6 @@ } ], "previews": [], - "descriptionHTML": "

Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.

", "statusCodes": [ { "httpStatusCode": "200", @@ -403718,7 +403717,8 @@ "httpStatusCode": "403", "description": "

Forbidden

" } - ] + ], + "descriptionHTML": "

Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.

" } ] }, @@ -432000,13 +432000,13 @@ } ], "previews": [], - "descriptionHTML": "

Updates a hosted compute network configuration for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the write:network_configurations scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Updates a hosted compute network configuration for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the write:network_configurations scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -432064,13 +432064,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a hosted compute network configuration from an organization.

\n

OAuth app tokens and personal access tokens (classic) need the write:network_configurations scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Deletes a hosted compute network configuration from an organization.

\n

OAuth app tokens and personal access tokens (classic) need the write:network_configurations scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -435350,7 +435350,6 @@ } ], "previews": [], - "descriptionHTML": "

Approves or denies a pending request to access organization resources via a fine-grained personal access token.

\n

Only GitHub Apps can use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -435372,7 +435371,8 @@ "httpStatusCode": "500", "description": "

Internal Error

" } - ] + ], + "descriptionHTML": "

Approves or denies a pending request to access organization resources via a fine-grained personal access token.

\n

Only GitHub Apps can use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -464936,13 +464936,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about the single most recent build of a GitHub Pages site.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets information about the single most recent build of a GitHub Pages site.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -561860,7 +561860,6 @@ } ], "previews": [], - "descriptionHTML": "

Lists comments for a specific pull request review.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -561870,7 +561869,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Lists comments for a specific pull request review.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n" }, { "serverUrl": "https://api.github.com", @@ -567516,7 +567516,6 @@ } ], "previews": [], - "descriptionHTML": "

Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.

", "statusCodes": [ { "httpStatusCode": "200", @@ -567530,7 +567529,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.

" }, { "serverUrl": "https://api.github.com", @@ -570857,13 +570857,13 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a release.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a release.

" }, { "serverUrl": "https://api.github.com", @@ -596642,13 +596642,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "https://api.github.com", @@ -598601,13 +598601,13 @@ } ], "previews": [], - "descriptionHTML": "

Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"About security alerts for vulnerable dependencies\".

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"About security alerts for vulnerable dependencies\".

" }, { "serverUrl": "https://api.github.com", @@ -615905,13 +615905,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.

\n

Note

\n

\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.

\n
", "statusCodes": [ { "httpStatusCode": "302", "description": "

Found

" } - ] + ], + "descriptionHTML": "

Gets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.

\n

Note

\n

\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.

\n
" } ], "custom-properties": [ @@ -617222,7 +617222,6 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", @@ -617232,7 +617231,8 @@ "httpStatusCode": "400", "description": "

Bad Request

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "https://api.github.com", @@ -631981,7 +631981,6 @@ } ], "previews": [], - "descriptionHTML": "

Get the history of a repository ruleset.

", "statusCodes": [ { "httpStatusCode": "200", @@ -631995,7 +631994,8 @@ "httpStatusCode": "500", "description": "

Internal Error

" } - ] + ], + "descriptionHTML": "

Get the history of a repository ruleset.

" }, { "serverUrl": "https://api.github.com", @@ -632291,7 +632291,6 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.

\n
\n

This returns the tag protection states of a repository.

\n

This information is only available to repository administrators.

", "statusCodes": [ { "httpStatusCode": "200", @@ -632305,7 +632304,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.

\n
\n

This returns the tag protection states of a repository.

\n

This information is only available to repository administrators.

" }, { "serverUrl": "https://api.github.com", @@ -691276,13 +691276,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a comment on a team discussion.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Deletes a comment on a team discussion.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -693077,13 +693077,13 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.

\n
\n

Edits the body text of a discussion comment.

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.

\n
\n

Edits the body text of a discussion comment.

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index b1d686a72b45..555a2b59eced 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -293283,7 +293283,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": false, + "fineGrainedPat": true, "permissions": [ { "\"Enterprise administration\" enterprise permissions": "write" 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 b9aeab777d59..f33e2fb442e2 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 @@ -206627,7 +206627,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": false, + "fineGrainedPat": true, "permissions": [ { "\"Enterprise administration\" enterprise permissions": "write" 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 32f2398d0f2e..1b66c7923f9a 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 @@ -210850,7 +210850,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": false, + "fineGrainedPat": true, "permissions": [ { "\"Enterprise administration\" enterprise permissions": "write" 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 e71b8a4b0ac6..85fe40e7f4fc 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 @@ -6066,13 +6066,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -8834,13 +8834,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a single environment secret without revealing its encrypted value.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a single environment secret without revealing its encrypted value.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10677,13 +10677,13 @@ } ], "previews": [], + "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -19989,6 +19989,7 @@ } ], "previews": [], + "descriptionHTML": "

Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -19998,8 +19999,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -71720,13 +71720,13 @@ } ], "previews": [], + "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -79969,13 +79969,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.

\n\n

By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"

\n

Note

\n

\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.

\n\n

By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"

\n

Note

\n

\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.

\n
" + ] } ], "notifications": [ @@ -197903,13 +197903,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -214694,13 +214694,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the audit log for an enterprise.

\n

The authenticated user must be an enterprise admin to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the audit log for an enterprise.

\n

The authenticated user must be an enterprise admin to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -216051,7 +216051,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": false, + "fineGrainedPat": true, "permissions": [ { "\"Enterprise administration\" enterprise permissions": "write" @@ -216664,13 +216664,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -221755,13 +221755,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -307992,13 +307992,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists labels for issues in a milestone.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists labels for issues in a milestone.

" + ] } ], "milestones": [ @@ -328515,6 +328515,7 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", @@ -328524,8 +328525,7 @@ "httpStatusCode": "304", "description": "

Not modified

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -334151,6 +334151,7 @@ } ], "previews": [], + "descriptionHTML": "

Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.

", "statusCodes": [ { "httpStatusCode": "204", @@ -334160,8 +334161,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -348404,6 +348404,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists all organizations, in the order that they were created.

\n

Note

\n

\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.

\n
", "statusCodes": [ { "httpStatusCode": "200", @@ -348413,8 +348414,7 @@ "httpStatusCode": "304", "description": "

Not modified

" } - ], - "descriptionHTML": "

Lists all organizations, in the order that they were created.

\n

Note

\n

\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.

\n
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -355637,6 +355637,7 @@ } ], "previews": [], + "descriptionHTML": "

Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.

\n

Note

\n

\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.

\n
", "statusCodes": [ { "httpStatusCode": "204", @@ -355646,8 +355647,7 @@ "httpStatusCode": "403", "description": "

Forbidden

" } - ], - "descriptionHTML": "

Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.

\n

Note

\n

\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.

\n
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -356934,13 +356934,13 @@ } ], "previews": [], + "descriptionHTML": "

Members of an organization can choose to have their membership publicized or not.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Members of an organization can choose to have their membership publicized or not.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -359618,6 +359618,7 @@ } ], "previews": [], + "descriptionHTML": "

Assigns an organization role to a team in an organization. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -359631,8 +359632,7 @@ "httpStatusCode": "422", "description": "

Response if the organization roles feature is not enabled for the organization, or validation failed.

" } - ], - "descriptionHTML": "

Assigns an organization role to a team in an organization. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -361099,6 +361099,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists the teams that are assigned to an organization role. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, you must be an administrator for the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -361112,8 +361113,7 @@ "httpStatusCode": "422", "description": "

Response if the organization roles feature is not enabled or validation failed.

" } - ], - "descriptionHTML": "

Lists the teams that are assigned to an organization role. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, you must be an administrator for the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -374387,6 +374387,7 @@ } ], "previews": [], + "descriptionHTML": "

Updates a webhook configured in an organization. When you update a webhook,\nthe secret will be overwritten. If you previously had a secret set, you must\nprovide the same secret or set a new secret or the secret will be removed. If\nyou are only updating individual webhook config properties, use \"Update a webhook\nconfiguration for an organization\".

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", "statusCodes": [ { "httpStatusCode": "200", @@ -374400,8 +374401,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Updates a webhook configured in an organization. When you update a webhook,\nthe secret will be overwritten. If you previously had a secret set, you must\nprovide the same secret or set a new secret or the secret will be removed. If\nyou are only updating individual webhook config properties, use \"Update a webhook\nconfiguration for an organization\".

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -374723,13 +374723,13 @@ } ], "previews": [], + "descriptionHTML": "

Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -388354,13 +388354,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific package metadata for a public package owned by a user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific package metadata for a public package owned by a user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -422082,13 +422082,13 @@ } ], "previews": [], + "descriptionHTML": "

Edits the content of a specified review comment.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Edits the content of a specified review comment.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -453441,13 +453441,13 @@ } ], "previews": [], + "descriptionHTML": "

Users with push access to the repository can edit a release asset.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Users with push access to the repository can edit a release asset.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -490418,13 +490418,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.

\n

Note

\n

\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.

\n
", "statusCodes": [ { "httpStatusCode": "302", "description": "

Found

" } - ], - "descriptionHTML": "

Gets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.

\n

Note

\n

\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.

\n
" + ] } ], "custom-properties": [ @@ -497024,6 +497024,7 @@ } ], "previews": [], + "descriptionHTML": "

Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"Managing rulesets for a repository.\"

", "statusCodes": [ { "httpStatusCode": "200", @@ -497037,8 +497038,7 @@ "httpStatusCode": "500", "description": "

Internal Error

" } - ], - "descriptionHTML": "

Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"Managing rulesets for a repository.\"

" + ] } ], "rules": [ diff --git a/src/rest/data/ghes-3.17-2022-11-28/schema.json b/src/rest/data/ghes-3.17-2022-11-28/schema.json index ccc78e071881..d50055328cd6 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.17-2022-11-28/schema.json @@ -216853,7 +216853,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": false, + "fineGrainedPat": true, "permissions": [ { "\"Enterprise administration\" enterprise permissions": "write"