diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index b07c79c360..9474a3ad01 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "09227d9129ab37f474e43d3b94f61c6ab7d9fde4" + "sha": "073a19144bae957c4198bf3ebba7100f2a7c2d65" } \ 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 70bd46ff33..a9aea6b881 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -99323,7 +99323,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -100276,7 +100276,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -100918,7 +100918,7 @@ "type": "object", "name": "permissions", "in": "body", - "description": "

The permissions granted to the user-to-server access token.

", + "description": "

The permissions granted to the user access token.

", "childParamsGroups": [ { "type": "string", @@ -101400,7 +101400,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -103360,31 +103360,31 @@ "type": "string", "name": "target", "in": "body", - "description": "

The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

" + "description": "

The name of the user or organization to scope the user access token to. Required unless target_id is specified.

" }, { "type": "integer", "name": "target_id", "in": "body", - "description": "

The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

" + "description": "

The ID of the user or organization to scope the user access token to. Required unless target is specified.

" }, { "type": "array of strings", "name": "repositories", "in": "body", - "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

" + "description": "

The list of repository names to scope the user access token to. repositories may not be specified if repository_ids is specified.

" }, { "type": "array of integers", "name": "repository_ids", "in": "body", - "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

" + "description": "

The list of repository IDs to scope the user access token to. repository_ids may not be specified if repositories is specified.

" }, { "type": "object", "name": "permissions", "in": "body", - "description": "

The permissions granted to the user-to-server access token.

", + "description": "

The permissions granted to the user access token.

", "childParamsGroups": [ { "type": "string", @@ -104055,7 +104055,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -104577,7 +104577,7 @@ } ], "previews": [], - "descriptionHTML": "

Use a non-scoped user-to-server access token to create a repository scoped and/or permission scoped user-to-server access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password. Invalid tokens will return 404 NOT FOUND.

", + "descriptionHTML": "

Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password. Invalid tokens will return 404 NOT FOUND.

", "statusCodes": [ { "httpStatusCode": "200", @@ -105424,7 +105424,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -106381,7 +106381,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -107336,7 +107336,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -110067,7 +110067,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -110606,7 +110606,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", + "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -112302,7 +112302,7 @@ } ], "previews": [], - "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", + "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -114960,7 +114960,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the active subscriptions for the authenticated user. You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.

", + "descriptionHTML": "

Lists the active subscriptions for the authenticated user. GitHub Apps must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.

", "statusCodes": [ { "httpStatusCode": "200", @@ -115282,7 +115282,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the active subscriptions for the authenticated user. You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.

", + "descriptionHTML": "

Lists the active subscriptions for the authenticated user. GitHub Apps must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.

", "statusCodes": [ { "httpStatusCode": "200", @@ -115723,7 +115723,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -116618,7 +116618,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -358123,7 +358123,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -367970,7 +367970,7 @@ }, "bypass_mode": { "type": "string", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", + "description": "The permission level required to bypass this ruleset.\n\n**Deprecation Notice:** The `bypass_mode` field is being deprecated. To add a bypass option to this ruleset, use `bypass_actors`. The `bypass_mode` field will no longer be included in the response.", "enum": [ "none", "repository", @@ -367984,6 +367984,10 @@ "title": "Repository Ruleset Bypass Actor", "type": "object", "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_id", + "actor_type" + ], "properties": { "actor_id": { "type": "integer", @@ -367992,6 +367996,7 @@ "actor_type": { "type": "string", "enum": [ + "Role", "Team", "Integration" ], @@ -368692,13 +368697,16 @@ { "type": "integer", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset

" + "description": "

The ID of the actor that can bypass a ruleset

", + "isRequired": true }, { "type": "string", "name": "actor_type", "description": "

The type of actor that can bypass a ruleset

", + "isRequired": true, "enum": [ + "Role", "Team", "Integration" ] @@ -369451,7 +369459,7 @@ }, "bypass_mode": { "type": "string", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", + "description": "The permission level required to bypass this ruleset.\n\n**Deprecation Notice:** The `bypass_mode` field is being deprecated. To add a bypass option to this ruleset, use `bypass_actors`. The `bypass_mode` field will no longer be included in the response.", "enum": [ "none", "repository", @@ -369465,6 +369473,10 @@ "title": "Repository Ruleset Bypass Actor", "type": "object", "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_id", + "actor_type" + ], "properties": { "actor_id": { "type": "integer", @@ -369473,6 +369485,7 @@ "actor_type": { "type": "string", "enum": [ + "Role", "Team", "Integration" ], @@ -370265,7 +370278,7 @@ }, "bypass_mode": { "type": "string", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", + "description": "The permission level required to bypass this ruleset.\n\n**Deprecation Notice:** The `bypass_mode` field is being deprecated. To add a bypass option to this ruleset, use `bypass_actors`. The `bypass_mode` field will no longer be included in the response.", "enum": [ "none", "repository", @@ -370279,6 +370292,10 @@ "title": "Repository Ruleset Bypass Actor", "type": "object", "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_id", + "actor_type" + ], "properties": { "actor_id": { "type": "integer", @@ -370287,6 +370304,7 @@ "actor_type": { "type": "string", "enum": [ + "Role", "Team", "Integration" ], @@ -370993,13 +371011,16 @@ { "type": "integer", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset

" + "description": "

The ID of the actor that can bypass a ruleset

", + "isRequired": true }, { "type": "string", "name": "actor_type", "description": "

The type of actor that can bypass a ruleset

", + "isRequired": true, "enum": [ + "Role", "Team", "Integration" ] @@ -371753,7 +371774,7 @@ }, "bypass_mode": { "type": "string", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", + "description": "The permission level required to bypass this ruleset.\n\n**Deprecation Notice:** The `bypass_mode` field is being deprecated. To add a bypass option to this ruleset, use `bypass_actors`. The `bypass_mode` field will no longer be included in the response.", "enum": [ "none", "repository", @@ -371767,6 +371788,10 @@ "title": "Repository Ruleset Bypass Actor", "type": "object", "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_id", + "actor_type" + ], "properties": { "actor_id": { "type": "integer", @@ -371775,6 +371800,7 @@ "actor_type": { "type": "string", "enum": [ + "Role", "Team", "Integration" ], @@ -488041,7 +488067,7 @@ }, "bypass_mode": { "type": "string", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", + "description": "The permission level required to bypass this ruleset.\n\n**Deprecation Notice:** The `bypass_mode` field is being deprecated. To add a bypass option to this ruleset, use `bypass_actors`. The `bypass_mode` field will no longer be included in the response.", "enum": [ "none", "repository", @@ -488055,6 +488081,10 @@ "title": "Repository Ruleset Bypass Actor", "type": "object", "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_id", + "actor_type" + ], "properties": { "actor_id": { "type": "integer", @@ -488063,6 +488093,7 @@ "actor_type": { "type": "string", "enum": [ + "Role", "Team", "Integration" ], @@ -488767,7 +488798,7 @@ "type": "string", "name": "bypass_mode", "in": "body", - "description": "

The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.

", + "description": "

The permission level required to bypass this ruleset.

\n

Deprecation Notice: The bypass_mode field is being deprecated. To add a bypass option to this ruleset, use bypass_actors. The bypass_mode field will no longer be included in the respnse.

", "enum": [ "none", "repository", @@ -488783,13 +488814,16 @@ { "type": "integer", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset

" + "description": "

The ID of the actor that can bypass a ruleset

", + "isRequired": true }, { "type": "string", "name": "actor_type", "description": "

The type of actor that can bypass a ruleset

", + "isRequired": true, "enum": [ + "Role", "Team", "Integration" ] @@ -489379,7 +489413,6 @@ "name": "super cool ruleset", "target": "branch", "enforcement": "active", - "bypass_mode": "repository", "bypass_actors": [ { "actor_id": 234, @@ -489423,7 +489456,7 @@ "source_type": "Repository", "source": "monalisa/my-repo", "enforcement": "active", - "bypass_mode": "repository", + "bypass_mode": "none", "bypass_actors": [ { "actor_id": 234, @@ -489512,7 +489545,7 @@ }, "bypass_mode": { "type": "string", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", + "description": "The permission level required to bypass this ruleset.\n\n**Deprecation Notice:** The `bypass_mode` field is being deprecated. To add a bypass option to this ruleset, use `bypass_actors`. The `bypass_mode` field will no longer be included in the response.", "enum": [ "none", "repository", @@ -489526,6 +489559,10 @@ "title": "Repository Ruleset Bypass Actor", "type": "object", "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_id", + "actor_type" + ], "properties": { "actor_id": { "type": "integer", @@ -489534,6 +489571,7 @@ "actor_type": { "type": "string", "enum": [ + "Role", "Team", "Integration" ], @@ -490247,7 +490285,7 @@ "source_type": "Repository", "source": "monalisa/my-repo", "enforcement": "active", - "bypass_mode": "repository", + "bypass_mode": "none", "bypass_actors": [ { "actor_id": 234, @@ -490336,7 +490374,7 @@ }, "bypass_mode": { "type": "string", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", + "description": "The permission level required to bypass this ruleset.\n\n**Deprecation Notice:** The `bypass_mode` field is being deprecated. To add a bypass option to this ruleset, use `bypass_actors`. The `bypass_mode` field will no longer be included in the response.", "enum": [ "none", "repository", @@ -490350,6 +490388,10 @@ "title": "Repository Ruleset Bypass Actor", "type": "object", "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_id", + "actor_type" + ], "properties": { "actor_id": { "type": "integer", @@ -490358,6 +490400,7 @@ "actor_type": { "type": "string", "enum": [ + "Role", "Team", "Integration" ], @@ -491068,7 +491111,7 @@ "type": "string", "name": "bypass_mode", "in": "body", - "description": "

The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.

", + "description": "

The permission level required to bypass this ruleset.

\n

Deprecation Notice: The bypass_mode field is being deprecated. To add a bypass option to this ruleset, use bypass_actors. The bypass_mode field will no longer be included in the respnse.

", "enum": [ "none", "repository", @@ -491084,13 +491127,16 @@ { "type": "integer", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset

" + "description": "

The ID of the actor that can bypass a ruleset

", + "isRequired": true }, { "type": "string", "name": "actor_type", "description": "

The type of actor that can bypass a ruleset

", + "isRequired": true, "enum": [ + "Role", "Team", "Integration" ] @@ -491680,7 +491726,6 @@ "name": "super cool ruleset", "target": "branch", "enforcement": "active", - "bypass_mode": "repository", "bypass_actors": [ { "actor_id": 234, @@ -491725,7 +491770,7 @@ "source_type": "Repository", "source": "monalisa/my-repo", "enforcement": "active", - "bypass_mode": "repository", + "bypass_mode": "none", "bypass_actors": [ { "actor_id": 234, @@ -491814,7 +491859,7 @@ }, "bypass_mode": { "type": "string", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", + "description": "The permission level required to bypass this ruleset.\n\n**Deprecation Notice:** The `bypass_mode` field is being deprecated. To add a bypass option to this ruleset, use `bypass_actors`. The `bypass_mode` field will no longer be included in the response.", "enum": [ "none", "repository", @@ -491828,6 +491873,10 @@ "title": "Repository Ruleset Bypass Actor", "type": "object", "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_id", + "actor_type" + ], "properties": { "actor_id": { "type": "integer", @@ -491836,6 +491885,7 @@ "actor_type": { "type": "string", "enum": [ + "Role", "Team", "Integration" ], @@ -498548,7 +498598,7 @@ } ], "previews": [], - "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", + "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghae/schema.json b/src/rest/data/ghae/schema.json index 398c8a7916..6b1ed349e5 100644 --- a/src/rest/data/ghae/schema.json +++ b/src/rest/data/ghae/schema.json @@ -60414,7 +60414,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -61351,7 +61351,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -61977,7 +61977,7 @@ "type": "object", "name": "permissions", "in": "body", - "description": "

The permissions granted to the user-to-server access token.

", + "description": "

The permissions granted to the user access token.

", "childParamsGroups": [ { "type": "string", @@ -62441,7 +62441,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -65088,7 +65088,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -66029,7 +66029,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -66968,7 +66968,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -69598,7 +69598,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -70121,7 +70121,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", + "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -71732,7 +71732,7 @@ } ], "previews": [], - "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", + "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -72321,7 +72321,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -73200,7 +73200,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -74139,7 +74139,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -112049,6 +112049,25 @@ ], "default": "created" } + }, + { + "name": "severity", + "description": "

If specified, only code scanning alerts with this severity will be returned.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "Severity of a code scanning alert.", + "enum": [ + "critical", + "high", + "medium", + "low", + "warning", + "note", + "error" + ] + } } ], "bodyParameters": [], @@ -113439,6 +113458,25 @@ "fixed" ] } + }, + { + "name": "severity", + "description": "

If specified, only code scanning alerts with this severity will be returned.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "Severity of a code scanning alert.", + "enum": [ + "critical", + "high", + "medium", + "low", + "warning", + "note", + "error" + ] + } } ], "bodyParameters": [], @@ -150957,7 +150995,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -151895,7 +151933,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -152703,7 +152741,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -260185,7 +260223,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -365989,7 +366027,7 @@ } ], "previews": [], - "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", + "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 2f6b5fd14f..f095f87c75 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -109439,7 +109439,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -110392,7 +110392,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -111034,7 +111034,7 @@ "type": "object", "name": "permissions", "in": "body", - "description": "

The permissions granted to the user-to-server access token.

", + "description": "

The permissions granted to the user access token.

", "childParamsGroups": [ { "type": "string", @@ -111516,7 +111516,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -113476,31 +113476,31 @@ "type": "string", "name": "target", "in": "body", - "description": "

The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

" + "description": "

The name of the user or organization to scope the user access token to. Required unless target_id is specified.

" }, { "type": "integer", "name": "target_id", "in": "body", - "description": "

The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

" + "description": "

The ID of the user or organization to scope the user access token to. Required unless target is specified.

" }, { "type": "array of strings", "name": "repositories", "in": "body", - "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

" + "description": "

The list of repository names to scope the user access token to. repositories may not be specified if repository_ids is specified.

" }, { "type": "array of integers", "name": "repository_ids", "in": "body", - "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

" + "description": "

The list of repository IDs to scope the user access token to. repository_ids may not be specified if repositories is specified.

" }, { "type": "object", "name": "permissions", "in": "body", - "description": "

The permissions granted to the user-to-server access token.

", + "description": "

The permissions granted to the user access token.

", "childParamsGroups": [ { "type": "string", @@ -114171,7 +114171,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -114693,7 +114693,7 @@ } ], "previews": [], - "descriptionHTML": "

Use a non-scoped user-to-server access token to create a repository scoped and/or permission scoped user-to-server access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password. Invalid tokens will return 404 NOT FOUND.

", + "descriptionHTML": "

Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password. Invalid tokens will return 404 NOT FOUND.

", "statusCodes": [ { "httpStatusCode": "200", @@ -115540,7 +115540,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -116497,7 +116497,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -117452,7 +117452,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -120183,7 +120183,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -120722,7 +120722,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", + "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -122418,7 +122418,7 @@ } ], "previews": [], - "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", + "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -125076,7 +125076,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the active subscriptions for the authenticated user. You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.

", + "descriptionHTML": "

Lists the active subscriptions for the authenticated user. GitHub Apps must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.

", "statusCodes": [ { "httpStatusCode": "200", @@ -125398,7 +125398,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the active subscriptions for the authenticated user. You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.

", + "descriptionHTML": "

Lists the active subscriptions for the authenticated user. GitHub Apps must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.

", "statusCodes": [ { "httpStatusCode": "200", @@ -125839,7 +125839,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -126734,7 +126734,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -372250,7 +372250,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -384998,7 +384998,7 @@ }, "bypass_mode": { "type": "string", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", + "description": "The permission level required to bypass this ruleset.\n\n**Deprecation Notice:** The `bypass_mode` field is being deprecated. To add a bypass option to this ruleset, use `bypass_actors`. The `bypass_mode` field will no longer be included in the response.", "enum": [ "none", "repository", @@ -385012,6 +385012,10 @@ "title": "Repository Ruleset Bypass Actor", "type": "object", "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_id", + "actor_type" + ], "properties": { "actor_id": { "type": "integer", @@ -385020,6 +385024,7 @@ "actor_type": { "type": "string", "enum": [ + "Role", "Team", "Integration" ], @@ -385720,13 +385725,16 @@ { "type": "integer", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset

" + "description": "

The ID of the actor that can bypass a ruleset

", + "isRequired": true }, { "type": "string", "name": "actor_type", "description": "

The type of actor that can bypass a ruleset

", + "isRequired": true, "enum": [ + "Role", "Team", "Integration" ] @@ -386479,7 +386487,7 @@ }, "bypass_mode": { "type": "string", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", + "description": "The permission level required to bypass this ruleset.\n\n**Deprecation Notice:** The `bypass_mode` field is being deprecated. To add a bypass option to this ruleset, use `bypass_actors`. The `bypass_mode` field will no longer be included in the response.", "enum": [ "none", "repository", @@ -386493,6 +386501,10 @@ "title": "Repository Ruleset Bypass Actor", "type": "object", "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_id", + "actor_type" + ], "properties": { "actor_id": { "type": "integer", @@ -386501,6 +386513,7 @@ "actor_type": { "type": "string", "enum": [ + "Role", "Team", "Integration" ], @@ -387293,7 +387306,7 @@ }, "bypass_mode": { "type": "string", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", + "description": "The permission level required to bypass this ruleset.\n\n**Deprecation Notice:** The `bypass_mode` field is being deprecated. To add a bypass option to this ruleset, use `bypass_actors`. The `bypass_mode` field will no longer be included in the response.", "enum": [ "none", "repository", @@ -387307,6 +387320,10 @@ "title": "Repository Ruleset Bypass Actor", "type": "object", "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_id", + "actor_type" + ], "properties": { "actor_id": { "type": "integer", @@ -387315,6 +387332,7 @@ "actor_type": { "type": "string", "enum": [ + "Role", "Team", "Integration" ], @@ -388021,13 +388039,16 @@ { "type": "integer", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset

" + "description": "

The ID of the actor that can bypass a ruleset

", + "isRequired": true }, { "type": "string", "name": "actor_type", "description": "

The type of actor that can bypass a ruleset

", + "isRequired": true, "enum": [ + "Role", "Team", "Integration" ] @@ -388781,7 +388802,7 @@ }, "bypass_mode": { "type": "string", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", + "description": "The permission level required to bypass this ruleset.\n\n**Deprecation Notice:** The `bypass_mode` field is being deprecated. To add a bypass option to this ruleset, use `bypass_actors`. The `bypass_mode` field will no longer be included in the response.", "enum": [ "none", "repository", @@ -388795,6 +388816,10 @@ "title": "Repository Ruleset Bypass Actor", "type": "object", "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_id", + "actor_type" + ], "properties": { "actor_id": { "type": "integer", @@ -388803,6 +388828,7 @@ "actor_type": { "type": "string", "enum": [ + "Role", "Team", "Integration" ], @@ -505076,7 +505102,7 @@ }, "bypass_mode": { "type": "string", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", + "description": "The permission level required to bypass this ruleset.\n\n**Deprecation Notice:** The `bypass_mode` field is being deprecated. To add a bypass option to this ruleset, use `bypass_actors`. The `bypass_mode` field will no longer be included in the response.", "enum": [ "none", "repository", @@ -505090,6 +505116,10 @@ "title": "Repository Ruleset Bypass Actor", "type": "object", "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_id", + "actor_type" + ], "properties": { "actor_id": { "type": "integer", @@ -505098,6 +505128,7 @@ "actor_type": { "type": "string", "enum": [ + "Role", "Team", "Integration" ], @@ -505802,7 +505833,7 @@ "type": "string", "name": "bypass_mode", "in": "body", - "description": "

The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.

", + "description": "

The permission level required to bypass this ruleset.

\n

Deprecation Notice: The bypass_mode field is being deprecated. To add a bypass option to this ruleset, use bypass_actors. The bypass_mode field will no longer be included in the respnse.

", "enum": [ "none", "repository", @@ -505818,13 +505849,16 @@ { "type": "integer", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset

" + "description": "

The ID of the actor that can bypass a ruleset

", + "isRequired": true }, { "type": "string", "name": "actor_type", "description": "

The type of actor that can bypass a ruleset

", + "isRequired": true, "enum": [ + "Role", "Team", "Integration" ] @@ -506414,7 +506448,6 @@ "name": "super cool ruleset", "target": "branch", "enforcement": "active", - "bypass_mode": "repository", "bypass_actors": [ { "actor_id": 234, @@ -506458,7 +506491,7 @@ "source_type": "Repository", "source": "monalisa/my-repo", "enforcement": "active", - "bypass_mode": "repository", + "bypass_mode": "none", "bypass_actors": [ { "actor_id": 234, @@ -506547,7 +506580,7 @@ }, "bypass_mode": { "type": "string", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", + "description": "The permission level required to bypass this ruleset.\n\n**Deprecation Notice:** The `bypass_mode` field is being deprecated. To add a bypass option to this ruleset, use `bypass_actors`. The `bypass_mode` field will no longer be included in the response.", "enum": [ "none", "repository", @@ -506561,6 +506594,10 @@ "title": "Repository Ruleset Bypass Actor", "type": "object", "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_id", + "actor_type" + ], "properties": { "actor_id": { "type": "integer", @@ -506569,6 +506606,7 @@ "actor_type": { "type": "string", "enum": [ + "Role", "Team", "Integration" ], @@ -507282,7 +507320,7 @@ "source_type": "Repository", "source": "monalisa/my-repo", "enforcement": "active", - "bypass_mode": "repository", + "bypass_mode": "none", "bypass_actors": [ { "actor_id": 234, @@ -507371,7 +507409,7 @@ }, "bypass_mode": { "type": "string", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", + "description": "The permission level required to bypass this ruleset.\n\n**Deprecation Notice:** The `bypass_mode` field is being deprecated. To add a bypass option to this ruleset, use `bypass_actors`. The `bypass_mode` field will no longer be included in the response.", "enum": [ "none", "repository", @@ -507385,6 +507423,10 @@ "title": "Repository Ruleset Bypass Actor", "type": "object", "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_id", + "actor_type" + ], "properties": { "actor_id": { "type": "integer", @@ -507393,6 +507435,7 @@ "actor_type": { "type": "string", "enum": [ + "Role", "Team", "Integration" ], @@ -508103,7 +508146,7 @@ "type": "string", "name": "bypass_mode", "in": "body", - "description": "

The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.

", + "description": "

The permission level required to bypass this ruleset.

\n

Deprecation Notice: The bypass_mode field is being deprecated. To add a bypass option to this ruleset, use bypass_actors. The bypass_mode field will no longer be included in the respnse.

", "enum": [ "none", "repository", @@ -508119,13 +508162,16 @@ { "type": "integer", "name": "actor_id", - "description": "

The ID of the actor that can bypass a ruleset

" + "description": "

The ID of the actor that can bypass a ruleset

", + "isRequired": true }, { "type": "string", "name": "actor_type", "description": "

The type of actor that can bypass a ruleset

", + "isRequired": true, "enum": [ + "Role", "Team", "Integration" ] @@ -508715,7 +508761,6 @@ "name": "super cool ruleset", "target": "branch", "enforcement": "active", - "bypass_mode": "repository", "bypass_actors": [ { "actor_id": 234, @@ -508760,7 +508805,7 @@ "source_type": "Repository", "source": "monalisa/my-repo", "enforcement": "active", - "bypass_mode": "repository", + "bypass_mode": "none", "bypass_actors": [ { "actor_id": 234, @@ -508849,7 +508894,7 @@ }, "bypass_mode": { "type": "string", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", + "description": "The permission level required to bypass this ruleset.\n\n**Deprecation Notice:** The `bypass_mode` field is being deprecated. To add a bypass option to this ruleset, use `bypass_actors`. The `bypass_mode` field will no longer be included in the response.", "enum": [ "none", "repository", @@ -508863,6 +508908,10 @@ "title": "Repository Ruleset Bypass Actor", "type": "object", "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_id", + "actor_type" + ], "properties": { "actor_id": { "type": "integer", @@ -508871,6 +508920,7 @@ "actor_type": { "type": "string", "enum": [ + "Role", "Team", "Integration" ], @@ -518069,7 +518119,7 @@ } ], "previews": [], - "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", + "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.4/schema.json b/src/rest/data/ghes-3.4/schema.json index 260bb0ce70..8946bb9c25 100644 --- a/src/rest/data/ghes-3.4/schema.json +++ b/src/rest/data/ghes-3.4/schema.json @@ -84814,7 +84814,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -85751,7 +85751,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -86377,7 +86377,7 @@ "type": "object", "name": "permissions", "in": "body", - "description": "

The permissions granted to the user-to-server access token.

", + "description": "

The permissions granted to the user access token.

", "childParamsGroups": [ { "type": "string", @@ -86841,7 +86841,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -88695,31 +88695,31 @@ "type": "string", "name": "target", "in": "body", - "description": "

The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

" + "description": "

The name of the user or organization to scope the user access token to. Required unless target_id is specified.

" }, { "type": "integer", "name": "target_id", "in": "body", - "description": "

The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

" + "description": "

The ID of the user or organization to scope the user access token to. Required unless target is specified.

" }, { "type": "array of strings", "name": "repositories", "in": "body", - "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

" + "description": "

The list of repository names to scope the user access token to. repositories may not be specified if repository_ids is specified.

" }, { "type": "array of integers", "name": "repository_ids", "in": "body", - "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

" + "description": "

The list of repository IDs to scope the user access token to. repository_ids may not be specified if repositories is specified.

" }, { "type": "object", "name": "permissions", "in": "body", - "description": "

The permissions granted to the user-to-server access token.

", + "description": "

The permissions granted to the user access token.

", "childParamsGroups": [ { "type": "string", @@ -89372,7 +89372,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -89878,7 +89878,7 @@ } ], "previews": [], - "descriptionHTML": "

Use a non-scoped user-to-server access token to create a repository scoped and/or permission scoped user-to-server access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password. Invalid tokens will return 404 NOT FOUND.

", + "descriptionHTML": "

Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password. Invalid tokens will return 404 NOT FOUND.

", "statusCodes": [ { "httpStatusCode": "200", @@ -90725,7 +90725,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -91666,7 +91666,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -92605,7 +92605,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -95230,7 +95230,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -95753,7 +95753,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", + "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -97359,7 +97359,7 @@ } ], "previews": [], - "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", + "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -97948,7 +97948,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -98827,7 +98827,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -182969,7 +182969,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -184213,7 +184213,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -185021,7 +185021,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -291042,7 +291042,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -291926,7 +291926,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -292825,7 +292825,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -293636,7 +293636,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -294539,7 +294539,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -295351,7 +295351,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -296192,7 +296192,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -297084,7 +297084,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -299778,7 +299778,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -408070,7 +408070,7 @@ } ], "previews": [], - "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", + "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.5/schema.json b/src/rest/data/ghes-3.5/schema.json index 2c354f260d..edbd8718b2 100644 --- a/src/rest/data/ghes-3.5/schema.json +++ b/src/rest/data/ghes-3.5/schema.json @@ -90525,7 +90525,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -91462,7 +91462,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -92088,7 +92088,7 @@ "type": "object", "name": "permissions", "in": "body", - "description": "

The permissions granted to the user-to-server access token.

", + "description": "

The permissions granted to the user access token.

", "childParamsGroups": [ { "type": "string", @@ -92552,7 +92552,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -94406,31 +94406,31 @@ "type": "string", "name": "target", "in": "body", - "description": "

The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

" + "description": "

The name of the user or organization to scope the user access token to. Required unless target_id is specified.

" }, { "type": "integer", "name": "target_id", "in": "body", - "description": "

The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

" + "description": "

The ID of the user or organization to scope the user access token to. Required unless target is specified.

" }, { "type": "array of strings", "name": "repositories", "in": "body", - "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

" + "description": "

The list of repository names to scope the user access token to. repositories may not be specified if repository_ids is specified.

" }, { "type": "array of integers", "name": "repository_ids", "in": "body", - "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

" + "description": "

The list of repository IDs to scope the user access token to. repository_ids may not be specified if repositories is specified.

" }, { "type": "object", "name": "permissions", "in": "body", - "description": "

The permissions granted to the user-to-server access token.

", + "description": "

The permissions granted to the user access token.

", "childParamsGroups": [ { "type": "string", @@ -95083,7 +95083,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -95589,7 +95589,7 @@ } ], "previews": [], - "descriptionHTML": "

Use a non-scoped user-to-server access token to create a repository scoped and/or permission scoped user-to-server access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password. Invalid tokens will return 404 NOT FOUND.

", + "descriptionHTML": "

Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password. Invalid tokens will return 404 NOT FOUND.

", "statusCodes": [ { "httpStatusCode": "200", @@ -96436,7 +96436,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -97377,7 +97377,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -98316,7 +98316,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -100941,7 +100941,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -101464,7 +101464,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", + "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -103070,7 +103070,7 @@ } ], "previews": [], - "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", + "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -103659,7 +103659,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -104538,7 +104538,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -190166,7 +190166,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -191410,7 +191410,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -192218,7 +192218,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -298251,7 +298251,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -299135,7 +299135,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -300034,7 +300034,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -300845,7 +300845,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -301748,7 +301748,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -302560,7 +302560,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -303401,7 +303401,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -304293,7 +304293,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -306987,7 +306987,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -415735,7 +415735,7 @@ } ], "previews": [], - "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", + "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.6/schema.json b/src/rest/data/ghes-3.6/schema.json index 4d1f9ad348..05a0ccaf6d 100644 --- a/src/rest/data/ghes-3.6/schema.json +++ b/src/rest/data/ghes-3.6/schema.json @@ -92796,7 +92796,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -93733,7 +93733,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -94359,7 +94359,7 @@ "type": "object", "name": "permissions", "in": "body", - "description": "

The permissions granted to the user-to-server access token.

", + "description": "

The permissions granted to the user access token.

", "childParamsGroups": [ { "type": "string", @@ -94823,7 +94823,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -96759,31 +96759,31 @@ "type": "string", "name": "target", "in": "body", - "description": "

The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

" + "description": "

The name of the user or organization to scope the user access token to. Required unless target_id is specified.

" }, { "type": "integer", "name": "target_id", "in": "body", - "description": "

The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

" + "description": "

The ID of the user or organization to scope the user access token to. Required unless target is specified.

" }, { "type": "array of strings", "name": "repositories", "in": "body", - "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

" + "description": "

The list of repository names to scope the user access token to. repositories may not be specified if repository_ids is specified.

" }, { "type": "array of integers", "name": "repository_ids", "in": "body", - "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

" + "description": "

The list of repository IDs to scope the user access token to. repository_ids may not be specified if repositories is specified.

" }, { "type": "object", "name": "permissions", "in": "body", - "description": "

The permissions granted to the user-to-server access token.

", + "description": "

The permissions granted to the user access token.

", "childParamsGroups": [ { "type": "string", @@ -97436,7 +97436,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -97942,7 +97942,7 @@ } ], "previews": [], - "descriptionHTML": "

Use a non-scoped user-to-server access token to create a repository scoped and/or permission scoped user-to-server access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password. Invalid tokens will return 404 NOT FOUND.

", + "descriptionHTML": "

Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password. Invalid tokens will return 404 NOT FOUND.

", "statusCodes": [ { "httpStatusCode": "200", @@ -98789,7 +98789,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -99730,7 +99730,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -100669,7 +100669,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -103376,7 +103376,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -103899,7 +103899,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", + "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -105587,7 +105587,7 @@ } ], "previews": [], - "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", + "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -106176,7 +106176,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -107055,7 +107055,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -198501,7 +198501,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -199745,7 +199745,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -200553,7 +200553,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -307992,7 +307992,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -308876,7 +308876,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -309775,7 +309775,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -310586,7 +310586,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -311489,7 +311489,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -312301,7 +312301,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -313142,7 +313142,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -314034,7 +314034,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -316749,7 +316749,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -427382,7 +427382,7 @@ } ], "previews": [], - "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", + "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.7/schema.json b/src/rest/data/ghes-3.7/schema.json index 5fed5a2961..a520fe984e 100644 --- a/src/rest/data/ghes-3.7/schema.json +++ b/src/rest/data/ghes-3.7/schema.json @@ -93743,7 +93743,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -94680,7 +94680,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -95306,7 +95306,7 @@ "type": "object", "name": "permissions", "in": "body", - "description": "

The permissions granted to the user-to-server access token.

", + "description": "

The permissions granted to the user access token.

", "childParamsGroups": [ { "type": "string", @@ -95770,7 +95770,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -97714,31 +97714,31 @@ "type": "string", "name": "target", "in": "body", - "description": "

The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

" + "description": "

The name of the user or organization to scope the user access token to. Required unless target_id is specified.

" }, { "type": "integer", "name": "target_id", "in": "body", - "description": "

The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

" + "description": "

The ID of the user or organization to scope the user access token to. Required unless target is specified.

" }, { "type": "array of strings", "name": "repositories", "in": "body", - "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

" + "description": "

The list of repository names to scope the user access token to. repositories may not be specified if repository_ids is specified.

" }, { "type": "array of integers", "name": "repository_ids", "in": "body", - "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

" + "description": "

The list of repository IDs to scope the user access token to. repository_ids may not be specified if repositories is specified.

" }, { "type": "object", "name": "permissions", "in": "body", - "description": "

The permissions granted to the user-to-server access token.

", + "description": "

The permissions granted to the user access token.

", "childParamsGroups": [ { "type": "string", @@ -98391,7 +98391,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -98897,7 +98897,7 @@ } ], "previews": [], - "descriptionHTML": "

Use a non-scoped user-to-server access token to create a repository scoped and/or permission scoped user-to-server access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password. Invalid tokens will return 404 NOT FOUND.

", + "descriptionHTML": "

Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password. Invalid tokens will return 404 NOT FOUND.

", "statusCodes": [ { "httpStatusCode": "200", @@ -99744,7 +99744,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -100685,7 +100685,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -101624,7 +101624,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -104339,7 +104339,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -104862,7 +104862,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", + "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -106558,7 +106558,7 @@ } ], "previews": [], - "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", + "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -107147,7 +107147,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -108026,7 +108026,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -201325,7 +201325,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -202576,7 +202576,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -203384,7 +203384,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -310965,7 +310965,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -311849,7 +311849,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -312748,7 +312748,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -313559,7 +313559,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -314462,7 +314462,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -315274,7 +315274,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -316115,7 +316115,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -317007,7 +317007,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -319854,7 +319854,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -431243,7 +431243,7 @@ } ], "previews": [], - "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", + "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.8/schema.json b/src/rest/data/ghes-3.8/schema.json index 5bb413b3d0..9bde0b2f0d 100644 --- a/src/rest/data/ghes-3.8/schema.json +++ b/src/rest/data/ghes-3.8/schema.json @@ -107790,7 +107790,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -108735,7 +108735,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -109369,7 +109369,7 @@ "type": "object", "name": "permissions", "in": "body", - "description": "

The permissions granted to the user-to-server access token.

", + "description": "

The permissions granted to the user access token.

", "childParamsGroups": [ { "type": "string", @@ -109842,7 +109842,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -111794,31 +111794,31 @@ "type": "string", "name": "target", "in": "body", - "description": "

The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

" + "description": "

The name of the user or organization to scope the user access token to. Required unless target_id is specified.

" }, { "type": "integer", "name": "target_id", "in": "body", - "description": "

The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

" + "description": "

The ID of the user or organization to scope the user access token to. Required unless target is specified.

" }, { "type": "array of strings", "name": "repositories", "in": "body", - "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

" + "description": "

The list of repository names to scope the user access token to. repositories may not be specified if repository_ids is specified.

" }, { "type": "array of integers", "name": "repository_ids", "in": "body", - "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

" + "description": "

The list of repository IDs to scope the user access token to. repository_ids may not be specified if repositories is specified.

" }, { "type": "object", "name": "permissions", "in": "body", - "description": "

The permissions granted to the user-to-server access token.

", + "description": "

The permissions granted to the user access token.

", "childParamsGroups": [ { "type": "string", @@ -112480,7 +112480,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -112994,7 +112994,7 @@ } ], "previews": [], - "descriptionHTML": "

Use a non-scoped user-to-server access token to create a repository scoped and/or permission scoped user-to-server access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password. Invalid tokens will return 404 NOT FOUND.

", + "descriptionHTML": "

Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password. Invalid tokens will return 404 NOT FOUND.

", "statusCodes": [ { "httpStatusCode": "200", @@ -113841,7 +113841,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -114790,7 +114790,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -115737,7 +115737,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -118460,7 +118460,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -118991,7 +118991,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", + "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -120687,7 +120687,7 @@ } ], "previews": [], - "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", + "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -121276,7 +121276,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -122163,7 +122163,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -222352,7 +222352,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -223611,7 +223611,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -224427,7 +224427,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -332038,7 +332038,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -332930,7 +332930,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -333837,7 +333837,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -334656,7 +334656,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -335567,7 +335567,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -336387,7 +336387,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -337236,7 +337236,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -338136,7 +338136,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -341041,7 +341041,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -452490,7 +452490,7 @@ } ], "previews": [], - "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", + "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.9-2022-11-28/schema.json b/src/rest/data/ghes-3.9-2022-11-28/schema.json index edff0e80fc..f7580c34f5 100644 --- a/src/rest/data/ghes-3.9-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.9-2022-11-28/schema.json @@ -108096,7 +108096,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -109049,7 +109049,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -109691,7 +109691,7 @@ "type": "object", "name": "permissions", "in": "body", - "description": "

The permissions granted to the user-to-server access token.

", + "description": "

The permissions granted to the user access token.

", "childParamsGroups": [ { "type": "string", @@ -110173,7 +110173,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -112133,31 +112133,31 @@ "type": "string", "name": "target", "in": "body", - "description": "

The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

" + "description": "

The name of the user or organization to scope the user access token to. Required unless target_id is specified.

" }, { "type": "integer", "name": "target_id", "in": "body", - "description": "

The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

" + "description": "

The ID of the user or organization to scope the user access token to. Required unless target is specified.

" }, { "type": "array of strings", "name": "repositories", "in": "body", - "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

" + "description": "

The list of repository names to scope the user access token to. repositories may not be specified if repository_ids is specified.

" }, { "type": "array of integers", "name": "repository_ids", "in": "body", - "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

" + "description": "

The list of repository IDs to scope the user access token to. repository_ids may not be specified if repositories is specified.

" }, { "type": "object", "name": "permissions", "in": "body", - "description": "

The permissions granted to the user-to-server access token.

", + "description": "

The permissions granted to the user access token.

", "childParamsGroups": [ { "type": "string", @@ -112828,7 +112828,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -113350,7 +113350,7 @@ } ], "previews": [], - "descriptionHTML": "

Use a non-scoped user-to-server access token to create a repository scoped and/or permission scoped user-to-server access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password. Invalid tokens will return 404 NOT FOUND.

", + "descriptionHTML": "

Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password. Invalid tokens will return 404 NOT FOUND.

", "statusCodes": [ { "httpStatusCode": "200", @@ -114197,7 +114197,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -115154,7 +115154,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -116109,7 +116109,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -118840,7 +118840,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -119379,7 +119379,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", + "descriptionHTML": "

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You can find the permissions for the installation under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -121075,7 +121075,7 @@ } ], "previews": [], - "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", + "descriptionHTML": "

List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

\n

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

\n

You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.

\n

The access the user has to each repository is included in the hash under the permissions key.

", "statusCodes": [ { "httpStatusCode": "200", @@ -121664,7 +121664,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -122559,7 +122559,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -223791,7 +223791,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -225058,7 +225058,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -225882,7 +225882,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -333501,7 +333501,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -334401,7 +334401,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -335316,7 +335316,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -336143,7 +336143,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -337062,7 +337062,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -337890,7 +337890,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -338747,7 +338747,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -339655,7 +339655,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -342626,7 +342626,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", @@ -469226,7 +469226,7 @@ } ], "previews": [], - "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", + "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note: For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 078c339335..bb7691b3c3 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -33,5 +33,5 @@ ] } }, - "sha": "09227d9129ab37f474e43d3b94f61c6ab7d9fde4" + "sha": "073a19144bae957c4198bf3ebba7100f2a7c2d65" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 0350b70545..3858099507 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -41384,7 +41384,7 @@ "github_app_authorization": { "revoked": { "descriptionHtml": "

Someone revoked their authorization of a GitHub App.

", - "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about user-to-server requests, which require GitHub App authorization, see \"Identifying and authorizing users for GitHub Apps.\"

", + "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about requests with a user access token, which require GitHub App authorization, see \"Authenticating with a GitHub App on behalf of a user.\"

", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/data/ghae/schema.json b/src/webhooks/data/ghae/schema.json index 3f19fb2ff4..0ee15a823a 100644 --- a/src/webhooks/data/ghae/schema.json +++ b/src/webhooks/data/ghae/schema.json @@ -40141,7 +40141,7 @@ "github_app_authorization": { "revoked": { "descriptionHtml": "

Someone revoked their authorization of a GitHub App.

", - "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about user-to-server requests, which require GitHub App authorization, see \"Identifying and authorizing users for GitHub Apps.\"

", + "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about requests with a user access token, which require GitHub App authorization, see \"Authenticating with a GitHub App on behalf of a user.\"

", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index c40793035d..e20117a10b 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -41384,7 +41384,7 @@ "github_app_authorization": { "revoked": { "descriptionHtml": "

Someone revoked their authorization of a GitHub App.

", - "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about user-to-server requests, which require GitHub App authorization, see \"Identifying and authorizing users for GitHub Apps.\"

", + "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about requests with a user access token, which require GitHub App authorization, see \"Authenticating with a GitHub App on behalf of a user.\"

", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/data/ghes-3.7/schema.json b/src/webhooks/data/ghes-3.7/schema.json index b819754bba..d04d4be644 100644 --- a/src/webhooks/data/ghes-3.7/schema.json +++ b/src/webhooks/data/ghes-3.7/schema.json @@ -35454,7 +35454,7 @@ "github_app_authorization": { "revoked": { "descriptionHtml": "

Someone revoked their authorization of a GitHub App.

", - "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about user-to-server requests, which require GitHub App authorization, see \"Identifying and authorizing users for GitHub Apps.\"

", + "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about requests with a user access token, which require GitHub App authorization, see \"Authenticating with a GitHub App on behalf of a user.\"

", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/data/ghes-3.8/schema.json b/src/webhooks/data/ghes-3.8/schema.json index 4564f87e4e..09221cfec1 100644 --- a/src/webhooks/data/ghes-3.8/schema.json +++ b/src/webhooks/data/ghes-3.8/schema.json @@ -35454,7 +35454,7 @@ "github_app_authorization": { "revoked": { "descriptionHtml": "

Someone revoked their authorization of a GitHub App.

", - "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about user-to-server requests, which require GitHub App authorization, see \"Identifying and authorizing users for GitHub Apps.\"

", + "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about requests with a user access token, which require GitHub App authorization, see \"Authenticating with a GitHub App on behalf of a user.\"

", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/data/ghes-3.9/schema.json b/src/webhooks/data/ghes-3.9/schema.json index b660165dec..ee1858219d 100644 --- a/src/webhooks/data/ghes-3.9/schema.json +++ b/src/webhooks/data/ghes-3.9/schema.json @@ -36604,7 +36604,7 @@ "github_app_authorization": { "revoked": { "descriptionHtml": "

Someone revoked their authorization of a GitHub App.

", - "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about user-to-server requests, which require GitHub App authorization, see \"Identifying and authorizing users for GitHub Apps.\"

", + "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about requests with a user access token, which require GitHub App authorization, see \"Authenticating with a GitHub App on behalf of a user.\"

", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index bb3ca6e68e..a8cfd2e856 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "09227d9129ab37f474e43d3b94f61c6ab7d9fde4" + "sha": "073a19144bae957c4198bf3ebba7100f2a7c2d65" } \ No newline at end of file