From 9f994e7e5b11972d62b47307ae7d99ffdce5b121 Mon Sep 17 00:00:00 2001 From: docubot <67483024+docubot@users.noreply.github.com> Date: Thu, 22 Jun 2023 01:52:46 -0700 Subject: [PATCH] Update OpenAPI Description (#38257) Co-authored-by: hubwriter --- src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 59 +++++++++++-------- src/rest/data/ghae/schema.json | 18 +++--- src/rest/data/ghec-2022-11-28/schema.json | 59 +++++++++++-------- src/rest/data/ghes-3.4/schema.json | 16 ++--- src/rest/data/ghes-3.5/schema.json | 16 ++--- src/rest/data/ghes-3.6/schema.json | 16 ++--- src/rest/data/ghes-3.7/schema.json | 16 ++--- src/rest/data/ghes-3.8/schema.json | 16 ++--- src/rest/data/ghes-3.9-2022-11-28/schema.json | 16 ++--- src/rest/lib/config.json | 2 +- src/webhooks/data/fpt/schema.json | 6 +- src/webhooks/data/ghec/schema.json | 6 +- src/webhooks/lib/config.json | 2 +- 14 files changed, 136 insertions(+), 114 deletions(-) diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 9474a3ad01..3d7c0ce0b3 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "073a19144bae957c4198bf3ebba7100f2a7c2d65" + "sha": "2a85eaee77f5691b0335f342a7fd30d559efe228" } \ 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 a9aea6b881..4e8405a14e 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -112882,7 +112882,7 @@ } ], "previews": [], - "descriptionHTML": "

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

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

Lists all plans that are part of your GitHub Marketplace listing.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Lists all plans that are part of your GitHub Marketplace listing.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

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

Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

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

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

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

Lists all plans that are part of your GitHub Marketplace listing.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Lists all plans that are part of your GitHub Marketplace listing.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

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

Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -114960,7 +114960,7 @@ } ], "previews": [], - "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.

", + "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. 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.

", + "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", @@ -145414,7 +145414,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

", + "descriptionHTML": "

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

", + "descriptionHTML": "

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

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

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.

", + "descriptionHTML": "

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth apps require the repo_deployment scope.

", "statusCodes": [ { "httpStatusCode": "201", @@ -506195,7 +506195,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, "name": { @@ -506672,7 +506673,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, { @@ -507464,7 +507466,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, "name": { @@ -507937,7 +507940,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, { @@ -508654,7 +508658,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, "name": { @@ -509767,7 +509772,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, "name": { @@ -510249,7 +510255,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, { @@ -511024,7 +511031,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, "name": { @@ -512085,7 +512093,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, "name": { diff --git a/src/rest/data/ghae/schema.json b/src/rest/data/ghae/schema.json index 6b1ed349e5..fdcfe5f0f6 100644 --- a/src/rest/data/ghae/schema.json +++ b/src/rest/data/ghae/schema.json @@ -74645,7 +74645,7 @@ } ], "previews": [], - "descriptionHTML": "

Deprecation Notice: GitHub AE will discontinue OAuth endpoints that contain access_token in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving access_token to the request body. For more information, see the blog post.

\n

OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. Invalid tokens will return 404 NOT FOUND.

", + "descriptionHTML": "

Deprecation Notice: GitHub AE will discontinue OAuth endpoints that contain access_token in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth apps by moving access_token to the request body. For more information, see the blog post.

\n

OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. Invalid tokens will return 404 NOT FOUND.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

", + "descriptionHTML": "

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

", + "descriptionHTML": "

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

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

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.

", + "descriptionHTML": "

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth apps require the repo_deployment scope.

", "statusCodes": [ { "httpStatusCode": "201", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index f095f87c75..fe0d4e5605 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -122998,7 +122998,7 @@ } ], "previews": [], - "descriptionHTML": "

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

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

Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

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

Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

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

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

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

Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

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

Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -125076,7 +125076,7 @@ } ], "previews": [], - "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.

", + "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. 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.

", + "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", @@ -155694,7 +155694,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

", + "descriptionHTML": "

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

", + "descriptionHTML": "

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

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

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.

", + "descriptionHTML": "

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth apps require the repo_deployment scope.

", "statusCodes": [ { "httpStatusCode": "201", @@ -525716,7 +525716,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, "name": { @@ -526193,7 +526194,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, { @@ -526985,7 +526987,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, "name": { @@ -527458,7 +527461,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, { @@ -528175,7 +528179,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, "name": { @@ -529288,7 +529293,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, "name": { @@ -529770,7 +529776,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, { @@ -530545,7 +530552,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, "name": { @@ -531606,7 +531614,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, "name": { diff --git a/src/rest/data/ghes-3.4/schema.json b/src/rest/data/ghes-3.4/schema.json index 8946bb9c25..c4388c39c7 100644 --- a/src/rest/data/ghes-3.4/schema.json +++ b/src/rest/data/ghes-3.4/schema.json @@ -126758,7 +126758,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

", + "descriptionHTML": "

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

", + "descriptionHTML": "

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

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

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.

", + "descriptionHTML": "

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth apps require the repo_deployment scope.

", "statusCodes": [ { "httpStatusCode": "201", diff --git a/src/rest/data/ghes-3.5/schema.json b/src/rest/data/ghes-3.5/schema.json index edbd8718b2..1a7e85d595 100644 --- a/src/rest/data/ghes-3.5/schema.json +++ b/src/rest/data/ghes-3.5/schema.json @@ -132469,7 +132469,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

", + "descriptionHTML": "

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

", + "descriptionHTML": "

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

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

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.

", + "descriptionHTML": "

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth apps require the repo_deployment scope.

", "statusCodes": [ { "httpStatusCode": "201", diff --git a/src/rest/data/ghes-3.6/schema.json b/src/rest/data/ghes-3.6/schema.json index 05a0ccaf6d..07bf27f357 100644 --- a/src/rest/data/ghes-3.6/schema.json +++ b/src/rest/data/ghes-3.6/schema.json @@ -134986,7 +134986,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

", + "descriptionHTML": "

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

", + "descriptionHTML": "

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

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

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.

", + "descriptionHTML": "

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth apps require the repo_deployment scope.

", "statusCodes": [ { "httpStatusCode": "201", diff --git a/src/rest/data/ghes-3.7/schema.json b/src/rest/data/ghes-3.7/schema.json index a520fe984e..26078327fa 100644 --- a/src/rest/data/ghes-3.7/schema.json +++ b/src/rest/data/ghes-3.7/schema.json @@ -135957,7 +135957,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

", + "descriptionHTML": "

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

", + "descriptionHTML": "

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

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

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.

", + "descriptionHTML": "

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth apps require the repo_deployment scope.

", "statusCodes": [ { "httpStatusCode": "201", diff --git a/src/rest/data/ghes-3.8/schema.json b/src/rest/data/ghes-3.8/schema.json index 9bde0b2f0d..d00e102faa 100644 --- a/src/rest/data/ghes-3.8/schema.json +++ b/src/rest/data/ghes-3.8/schema.json @@ -150304,7 +150304,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

", + "descriptionHTML": "

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

", + "descriptionHTML": "

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

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

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.

", + "descriptionHTML": "

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth apps require the repo_deployment scope.

", "statusCodes": [ { "httpStatusCode": "201", 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 f7580c34f5..209178c87d 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 @@ -150732,7 +150732,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

", + "descriptionHTML": "

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the repo scope to get check runs in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the repo scope to get check suites in a private repository.

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

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

", + "descriptionHTML": "

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

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

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.

", + "descriptionHTML": "

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

\n

GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth apps require the repo_deployment scope.

", "statusCodes": [ { "httpStatusCode": "201", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index bb7691b3c3..dd14bce01b 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -33,5 +33,5 @@ ] } }, - "sha": "073a19144bae957c4198bf3ebba7100f2a7c2d65" + "sha": "2a85eaee77f5691b0335f342a7fd30d559efe228" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 3858099507..5ff541a87c 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -162952,7 +162952,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, { @@ -163467,7 +163468,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, { diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index e20117a10b..a2ff3ccb20 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -162952,7 +162952,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, { @@ -163467,7 +163468,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ] }, { diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index a8cfd2e856..c21de8ff9d 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "073a19144bae957c4198bf3ebba7100f2a7c2d65" + "sha": "2a85eaee77f5691b0335f342a7fd30d559efe228" } \ No newline at end of file