diff --git a/.changeset/strange-birds-jam.md b/.changeset/strange-birds-jam.md
new file mode 100644
index 000000000..b5659db92
--- /dev/null
+++ b/.changeset/strange-birds-jam.md
@@ -0,0 +1,5 @@
+---
+"openapi-typescript": minor
+---
+
+Revert optional parameters breaking change (v6.6.0, #1335)
diff --git a/packages/openapi-typescript/examples/digital-ocean-api.ts b/packages/openapi-typescript/examples/digital-ocean-api.ts
index 7ca99daae..c67299321 100644
--- a/packages/openapi-typescript/examples/digital-ocean-api.ts
+++ b/packages/openapi-typescript/examples/digital-ocean-api.ts
@@ -754,7 +754,7 @@ export interface external {
* 1-Click application data, each of which will contain the the slug and type for the 1-Click.
*/
"resources/1-clicks/oneClicks_list.yml": {
- parameters?: {
+ parameters: {
query?: {
type?: external["resources/1-clicks/parameters.yml"]["oneClicks_type"];
};
@@ -905,7 +905,7 @@ export interface external {
* @description This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default.
*/
"resources/actions/actions_list.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -1112,7 +1112,7 @@ export interface external {
* @description Create a new app by submitting an app specification. For documentation on app specifications (`AppSpec` objects), please refer to [the product documentation](https://docs.digitalocean.com/products/app-platform/reference/app-spec/).
*/
"resources/apps/apps_create.yml": {
- parameters?: {
+ parameters: {
header?: {
Accept?: external["resources/apps/parameters.yml"]["accept"];
"Content-Type"?: external["resources/apps/parameters.yml"]["content-type"];
@@ -1497,7 +1497,7 @@ export interface external {
* @description List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app.
*/
"resources/apps/apps_list.yml": {
- parameters?: {
+ parameters: {
query?: {
page?: external["shared/parameters.yml"]["page"];
per_page?: external["shared/parameters.yml"]["per_page"];
@@ -3277,7 +3277,7 @@ export interface external {
* @description To retrieve a list of all invoices, send a GET request to `/v2/customers/my/invoices`.
*/
"resources/billing/invoices_list.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -3716,7 +3716,7 @@ export interface external {
* @description To list all of the CDN endpoints available on your account, send a GET request to `/v2/cdn/endpoints`.
*/
"resources/cdn/cdn_list_endpoints.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -3959,7 +3959,7 @@ export interface external {
* @description To list all of the certificates available on your account, send a GET request to `/v2/certificates`.
*/
"resources/certificates/certificates_list.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -4795,7 +4795,7 @@ export interface external {
* The embedded `maintenance_window` object will contain information about any scheduled maintenance for the database cluster.
*/
"resources/databases/databases_list_clusters.yml": {
- parameters?: {
+ parameters: {
query?: {
tag_name?: external["resources/databases/parameters.yml"]["tag_name"];
};
@@ -6783,7 +6783,7 @@ export interface external {
* @description To retrieve a list of all of the domains in your account, send a GET request to `/v2/domains`.
*/
"resources/domains/domains_list.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -7110,7 +7110,7 @@ export interface external {
* - `snapshot`
*/
"resources/droplets/dropletActions_post_byTag.yml": {
- parameters?: {
+ parameters: {
query?: {
tag_name?: external["resources/droplets/parameters.yml"]["droplet_tag_name"];
};
@@ -7603,7 +7603,7 @@ export interface external {
* `/v2/droplets?tag_name=$TAG_NAME`.
*/
"resources/droplets/droplets_list.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -8683,7 +8683,7 @@ export interface external {
* @description To list all of the firewalls available on your account, send a GET request to `/v2/firewalls`.
*/
"resources/firewalls/firewalls_list.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -8945,7 +8945,7 @@ export interface external {
* @description To list all of the floating IPs available on your account, send a GET request to `/v2/floating_ips`.
*/
"resources/floating_ips/floatingIPs_list.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -9804,7 +9804,7 @@ export interface external {
* To list all images assigned to a specific tag, include the `tag_name` query parameter set to the name of the tag in your GET request. For example, `/v2/images?tag_name=$TAG_NAME`.
*/
"resources/images/images_list.yml": {
- parameters?: {
+ parameters: {
query?: {
type?: external["resources/images/parameters.yml"]["type"];
private?: external["resources/images/parameters.yml"]["private"];
@@ -10443,7 +10443,7 @@ export interface external {
* to `/v2/kubernetes/clusters`.
*/
"resources/kubernetes/kubernetes_list_clusters.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -11508,7 +11508,7 @@ export interface external {
* to `/v2/load_balancers`.
*/
"resources/load_balancers/loadBalancers_list.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -12372,7 +12372,7 @@ export interface external {
* @description Returns all alert policies that are configured for the given account. To List all alert policies, send a GET request to `/v2/monitoring/alerts`.
*/
"resources/monitoring/monitoring_list_alertPolicy.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -12787,7 +12787,7 @@ export interface external {
* @description To list all your projects, send a GET request to `/v2/projects`.
*/
"resources/projects/projects_list.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -13023,7 +13023,7 @@ export interface external {
* The response will be a JSON object with a key called `regions`. The value of this will be an array of `region` objects, each of which will contain the standard region attributes.
*/
"resources/regions/regions_list.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -13447,7 +13447,7 @@ export interface external {
* credentials that expire after one hour.
*/
"resources/registry/registry_get_dockerCredentials.yml": {
- parameters?: {
+ parameters: {
query?: {
expiry_seconds?: external["resources/registry/parameters.yml"]["registry_expiry_seconds"];
read_write?: external["resources/registry/parameters.yml"]["registry_read_write"];
@@ -14036,7 +14036,7 @@ export interface external {
* @description To list all of the reserved IPs available on your account, send a GET request to `/v2/reserved_ips`.
*/
"resources/reserved_ips/reservedIPs_list.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -14284,7 +14284,7 @@ export interface external {
* The response will be a JSON object with a key called `sizes`. The value of this will be an array of `size` objects each of which contain the standard size attributes.
*/
"resources/sizes/sizes_list.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -14457,7 +14457,7 @@ export interface external {
* query parameter set to `volume`. For example, `/v2/snapshots?resource_type=volume`.
*/
"resources/snapshots/snapshots_list.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -14597,7 +14597,7 @@ export interface external {
* @description To list all of the keys in your account, send a GET request to `/v2/account/keys`. The response will be a JSON object with a key set to `ssh_keys`. The value of this will be an array of ssh_key objects, each of which contains the standard ssh_key attributes.
*/
"resources/ssh_keys/sshKeys_list.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -14868,7 +14868,7 @@ export interface external {
* @description To list all of your tags, you can send a GET request to `/v2/tags`.
*/
"resources/tags/tags_list.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -15090,7 +15090,7 @@ export interface external {
* @description To list all of the Uptime checks on your account, send a GET request to `/v2/uptime/checks`.
*/
"resources/uptime/list_checks.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -15694,7 +15694,7 @@ export interface external {
* | region | Set to the slug representing the region where the volume is located |
*/
"resources/volumes/volumeActions_post.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
@@ -15740,7 +15740,7 @@ export interface external {
* No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
*/
"resources/volumes/volumes_delete_byName.yml": {
- parameters?: {
+ parameters: {
query?: {
name?: external["resources/volumes/parameters.yml"]["volume_name"];
region?: external["shared/parameters.yml"]["region"];
@@ -15807,7 +15807,7 @@ export interface external {
* It is also possible to retrieve information about a block storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`.
*/
"resources/volumes/volumes_list.yml": {
- parameters?: {
+ parameters: {
query?: {
name?: external["resources/volumes/parameters.yml"]["volume_name"];
region?: external["shared/parameters.yml"]["region"];
@@ -16128,7 +16128,7 @@ export interface external {
* @description To list all of the VPCs on your account, send a GET request to `/v2/vpcs`.
*/
"resources/vpcs/vpcs_list.yml": {
- parameters?: {
+ parameters: {
query?: {
per_page?: external["shared/parameters.yml"]["per_page"];
page?: external["shared/parameters.yml"]["page"];
diff --git a/packages/openapi-typescript/examples/github-api-next.ts b/packages/openapi-typescript/examples/github-api-next.ts
index e66fe8d0d..8d3313ac4 100644
--- a/packages/openapi-typescript/examples/github-api-next.ts
+++ b/packages/openapi-typescript/examples/github-api-next.ts
@@ -2610,7 +2610,6 @@ export interface paths {
* @description Re-run a job and its dependent jobs in a workflow run.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions:write` permission to use this endpoint.
*/
post: operations["actions/re-run-job-for-workflow-run"];
@@ -2649,7 +2648,6 @@ export interface paths {
* @description Lists all organiation variables shared with a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -2735,7 +2733,6 @@ export interface paths {
* @description Lists all self-hosted runners configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2747,7 +2744,6 @@ export interface paths {
* @description Lists binaries for the runner application that you can download and run.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2759,7 +2755,6 @@ export interface paths {
* @description Generates a configuration that can be passed to the runner application at startup.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2772,7 +2767,6 @@ export interface paths {
* expires after one hour.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*
@@ -2792,7 +2786,6 @@ export interface paths {
* a repository. The token expires after one hour.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*
@@ -2811,7 +2804,6 @@ export interface paths {
* @description Gets a specific self-hosted runner configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2821,7 +2813,6 @@ export interface paths {
* @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2833,7 +2824,6 @@ export interface paths {
* @description Lists all labels for a self-hosted runner configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2844,7 +2834,6 @@ export interface paths {
* self-hosted runner configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2854,7 +2843,6 @@ export interface paths {
* @description Add custom labels to a self-hosted runner configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2865,7 +2853,6 @@ export interface paths {
* repository. Returns the remaining read-only labels from the runner.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2881,7 +2868,6 @@ export interface paths {
* present on the runner.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2966,7 +2952,6 @@ export interface paths {
* @description Cancels a workflow run using its `id`.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions:write` permission to use this endpoint.
*/
post: operations["actions/cancel-workflow-run"];
@@ -2984,6 +2969,17 @@ export interface paths {
*/
post: operations["actions/review-custom-gates-for-run"];
};
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": {
+ /**
+ * Force cancel a workflow run
+ * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.
+ * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).
+ *
+ * You must authenticate using an access token with the `repo` scope to use this endpoint.
+ * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ */
+ post: operations["actions/force-cancel-workflow-run"];
+ };
"/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": {
/**
* List jobs for a workflow run
@@ -3105,7 +3101,6 @@ export interface paths {
* List repository variables
* @description Lists all repository variables.
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -3115,7 +3110,6 @@ export interface paths {
* @description Creates a repository variable that you can reference in a GitHub Actions workflow.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -3127,7 +3121,6 @@ export interface paths {
* @description Gets a specific variable in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -3137,7 +3130,6 @@ export interface paths {
* @description Deletes a repository variable using the variable name.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -3147,7 +3139,6 @@ export interface paths {
* @description Updates a repository variable that you can reference in a GitHub Actions workflow.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -4287,10 +4278,8 @@ export interface paths {
* README, and CONTRIBUTING files.
*
* The `health_percentage` score is defined as a percentage of how many of
- * these four documents are present: README, CONTRIBUTING, LICENSE, and
- * CODE_OF_CONDUCT. For example, if all four documents are present, then
- * the `health_percentage` is `100`. If only one is present, then the
- * `health_percentage` is `25`.
+ * the recommended community health files are present. For more information, see
+ * "[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)."
*
* `content_reports_enabled` is only returned for organization-owned repositories.
*/
@@ -6482,7 +6471,6 @@ export interface paths {
* @description Lists all environment variables.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environments:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -6492,7 +6480,6 @@ export interface paths {
* @description Create an environment variable that you can reference in a GitHub Actions workflow.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environment:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -6504,7 +6491,6 @@ export interface paths {
* @description Gets a specific variable in an environment.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environments:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -6514,7 +6500,6 @@ export interface paths {
* @description Deletes an environment variable using the variable name.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environment:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -6524,7 +6509,6 @@ export interface paths {
* @description Updates an environment variable that you can reference in a GitHub Actions workflow.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environment:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -14387,7 +14371,7 @@ export interface components {
};
/**
* required_linear_history
- * @description Prevent merge commits from being pushed to matching branches.
+ * @description Prevent merge commits from being pushed to matching refs.
*/
"repository-rule-required-linear-history": {
/** @enum {string} */
@@ -14395,7 +14379,7 @@ export interface components {
};
/**
* required_deployments
- * @description Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
+ * @description Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
*/
"repository-rule-required-deployments": {
/** @enum {string} */
@@ -14407,7 +14391,7 @@ export interface components {
};
/**
* required_signatures
- * @description Commits pushed to matching branches must have verified signatures.
+ * @description Commits pushed to matching refs must have verified signatures.
*/
"repository-rule-required-signatures": {
/** @enum {string} */
@@ -14445,7 +14429,7 @@ export interface components {
};
/**
* required_status_checks
- * @description Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
+ * @description Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
*/
"repository-rule-required-status-checks": {
/** @enum {string} */
@@ -14459,7 +14443,7 @@ export interface components {
};
/**
* non_fast_forward
- * @description Prevent users with push access from force pushing to branches.
+ * @description Prevent users with push access from force pushing to refs.
*/
"repository-rule-non-fast-forward": {
/** @enum {string} */
@@ -17736,6 +17720,8 @@ export interface components {
} | ({
id: number;
node_id: string;
+ /** @description Whether deployments to this environment can be approved by the user who created the deployment. */
+ prevent_self_review?: boolean;
type: string;
/** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */
reviewers?: ({
@@ -80168,7 +80154,7 @@ export interface components {
"tool-name"?: components["schemas"]["code-scanning-analysis-tool-name"];
/** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */
"tool-guid"?: components["schemas"]["code-scanning-analysis-tool-guid"];
- /** @description The unique identifier of the hook. */
+ /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
"hook-id": number;
/** @description The unique identifier of the invitation. */
"invitation-id": number;
@@ -80397,7 +80383,7 @@ export interface operations {
* By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)."
*/
"security-advisories/list-global-advisories": {
- parameters?: {
+ parameters: {
query?: {
/** @description If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned. */
ghsa_id?: string;
@@ -80579,7 +80565,7 @@ export interface operations {
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*/
"apps/list-webhook-deliveries": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
cursor?: components["parameters"]["cursor"];
@@ -80643,7 +80629,7 @@ export interface operations {
* @description Lists all the pending installation requests for the authenticated GitHub App.
*/
"apps/list-installation-requests-for-authenticated-app": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -80667,7 +80653,7 @@ export interface operations {
* The permissions the installation has are included under the `permissions` key.
*/
"apps/list-installations": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -81046,7 +81032,7 @@ export interface operations {
* @description Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.
*/
"classroom/list-classrooms": {
- parameters?: {
+ parameters: {
query?: {
page?: components["parameters"]["page"];
per_page?: components["parameters"]["per-page"];
@@ -81237,7 +81223,7 @@ export interface operations {
* @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.
*/
"activity/list-public-events": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -81284,7 +81270,7 @@ export interface operations {
* @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:
*/
"gists/list": {
- parameters?: {
+ parameters: {
query?: {
since?: components["parameters"]["since"];
per_page?: components["parameters"]["per-page"];
@@ -81352,7 +81338,7 @@ export interface operations {
* Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.
*/
"gists/list-public": {
- parameters?: {
+ parameters: {
query?: {
since?: components["parameters"]["since"];
per_page?: components["parameters"]["per-page"];
@@ -81379,7 +81365,7 @@ export interface operations {
* @description List the authenticated user's starred gists:
*/
"gists/list-starred": {
- parameters?: {
+ parameters: {
query?: {
since?: components["parameters"]["since"];
per_page?: components["parameters"]["per-page"];
@@ -81802,7 +81788,7 @@ export interface operations {
* You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.
*/
"apps/list-repos-accessible-to-installation": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -81856,7 +81842,7 @@ export interface operations {
* request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
*/
"issues/list": {
- parameters?: {
+ parameters: {
query?: {
/** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */
filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all";
@@ -81895,7 +81881,7 @@ export interface operations {
* @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)."
*/
"licenses/get-all-commonly-used": {
- parameters?: {
+ parameters: {
query?: {
featured?: boolean;
per_page?: components["parameters"]["per-page"];
@@ -82027,7 +82013,7 @@ export interface operations {
* GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
*/
"apps/list-plans": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -82114,7 +82100,7 @@ export interface operations {
* GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
*/
"apps/list-plans-stubbed": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -82216,7 +82202,7 @@ export interface operations {
* @description List all notifications for the current user, sorted by most recently updated.
*/
"activity/list-notifications-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
all?: components["parameters"]["all"];
participating?: components["parameters"]["participating"];
@@ -82406,7 +82392,7 @@ export interface operations {
* @description Get the octocat as ASCII art
*/
"meta/get-octocat": {
- parameters?: {
+ parameters: {
query?: {
/** @description The words to show in Octocat's speech bubble */
s?: string;
@@ -82428,7 +82414,7 @@ export interface operations {
* **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.
*/
"orgs/list": {
- parameters?: {
+ parameters: {
query?: {
since?: components["parameters"]["since-org"];
per_page?: components["parameters"]["per-page"];
@@ -89740,7 +89726,6 @@ export interface operations {
* @description Re-run a job and its dependent jobs in a workflow run.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions:write` permission to use this endpoint.
*/
"actions/re-run-job-for-workflow-run": {
@@ -89871,7 +89856,6 @@ export interface operations {
* @description Lists all organiation variables shared with a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -90111,7 +90095,6 @@ export interface operations {
* @description Lists all self-hosted runners configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -90148,7 +90131,6 @@ export interface operations {
* @description Lists binaries for the runner application that you can download and run.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -90173,7 +90155,6 @@ export interface operations {
* @description Generates a configuration that can be passed to the runner application at startup.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -90213,7 +90194,6 @@ export interface operations {
* expires after one hour.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*
@@ -90246,7 +90226,6 @@ export interface operations {
* a repository. The token expires after one hour.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*
@@ -90278,7 +90257,6 @@ export interface operations {
* @description Gets a specific self-hosted runner configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -90304,7 +90282,6 @@ export interface operations {
* @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -90328,7 +90305,6 @@ export interface operations {
* @description Lists all labels for a self-hosted runner configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -90351,7 +90327,6 @@ export interface operations {
* self-hosted runner configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -90382,7 +90357,6 @@ export interface operations {
* @description Add custom labels to a self-hosted runner configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -90414,7 +90388,6 @@ export interface operations {
* repository. Returns the remaining read-only labels from the runner.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -90440,7 +90413,6 @@ export interface operations {
* present on the runner.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -90715,7 +90687,6 @@ export interface operations {
* @description Cancels a workflow run using its `id`.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions:write` permission to use this endpoint.
*/
"actions/cancel-workflow-run": {
@@ -90766,6 +90737,32 @@ export interface operations {
};
};
};
+ /**
+ * Force cancel a workflow run
+ * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.
+ * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).
+ *
+ * You must authenticate using an access token with the `repo` scope to use this endpoint.
+ * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ */
+ "actions/force-cancel-workflow-run": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 202: {
+ content: {
+ "application/json": components["schemas"]["empty-object"];
+ };
+ };
+ 409: components["responses"]["conflict"];
+ };
+ };
/**
* List jobs for a workflow run
* @description Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
@@ -91147,7 +91144,6 @@ export interface operations {
* List repository variables
* @description Lists all repository variables.
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -91182,7 +91178,6 @@ export interface operations {
* @description Creates a repository variable that you can reference in a GitHub Actions workflow.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -91217,7 +91212,6 @@ export interface operations {
* @description Gets a specific variable in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -91243,7 +91237,6 @@ export interface operations {
* @description Deletes a repository variable using the variable name.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -91267,7 +91260,6 @@ export interface operations {
* @description Updates a repository variable that you can reference in a GitHub Actions workflow.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -95103,10 +95095,8 @@ export interface operations {
* README, and CONTRIBUTING files.
*
* The `health_percentage` score is defined as a percentage of how many of
- * these four documents are present: README, CONTRIBUTING, LICENSE, and
- * CODE_OF_CONDUCT. For example, if all four documents are present, then
- * the `health_percentage` is `100`. If only one is present, then the
- * `health_percentage` is `25`.
+ * the recommended community health files are present. For more information, see
+ * "[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)."
*
* `content_reports_enabled` is only returned for organization-owned repositories.
*/
@@ -103073,7 +103063,7 @@ export interface operations {
* - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.
*/
"repos/list-public": {
- parameters?: {
+ parameters: {
query?: {
since?: components["parameters"]["since-repo"];
};
@@ -103247,7 +103237,6 @@ export interface operations {
* @description Lists all environment variables.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environments:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -103282,7 +103271,6 @@ export interface operations {
* @description Create an environment variable that you can reference in a GitHub Actions workflow.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environment:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -103317,7 +103305,6 @@ export interface operations {
* @description Gets a specific variable in an environment.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environments:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -103343,7 +103330,6 @@ export interface operations {
* @description Deletes an environment variable using the variable name.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environment:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -103367,7 +103353,6 @@ export interface operations {
* @description Updates an environment variable that you can reference in a GitHub Actions workflow.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environment:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -104839,7 +104824,7 @@ export interface operations {
* @description List the users you've blocked on your personal account.
*/
"users/list-blocked-by-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -104936,7 +104921,7 @@ export interface operations {
* GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.
*/
"codespaces/list-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -105056,7 +105041,7 @@ export interface operations {
* GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.
*/
"codespaces/list-secrets-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -105626,7 +105611,7 @@ export interface operations {
* @description Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.
*/
"users/list-emails-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -105705,7 +105690,7 @@ export interface operations {
* @description Lists the people following the authenticated user.
*/
"users/list-followers-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -105731,7 +105716,7 @@ export interface operations {
* @description Lists the people who the authenticated user follows.
*/
"users/list-followed-by-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -105824,7 +105809,7 @@ export interface operations {
* @description Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
*/
"users/list-gpg-keys-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -105931,7 +105916,7 @@ export interface operations {
* You can find the permissions for the installation under the `permissions` key.
*/
"apps/list-installations-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -106104,7 +106089,7 @@ export interface operations {
* request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
*/
"issues/list-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
/** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */
filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all";
@@ -106138,7 +106123,7 @@ export interface operations {
* @description Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
*/
"users/list-public-ssh-keys-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -106238,7 +106223,7 @@ export interface operations {
* @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps).
*/
"apps/list-subscriptions-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -106264,7 +106249,7 @@ export interface operations {
* @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps).
*/
"apps/list-subscriptions-for-authenticated-user-stubbed": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -106289,7 +106274,7 @@ export interface operations {
* @description Lists all of the authenticated user's organization memberships.
*/
"orgs/list-memberships-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
/** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */
state?: "active" | "pending";
@@ -106372,7 +106357,7 @@ export interface operations {
* @description Lists all migrations a user has started.
*/
"migrations/list-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -106589,7 +106574,7 @@ export interface operations {
* This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response.
*/
"orgs/list-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -106853,7 +106838,7 @@ export interface operations {
* @description Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.
*/
"users/list-public-emails-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -106882,7 +106867,7 @@ export interface operations {
* The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
*/
"repos/list-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
/** @description Limit results to repositories with the specified visibility. */
visibility?: "all" | "public" | "private";
@@ -107071,7 +107056,7 @@ export interface operations {
* @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user.
*/
"repos/list-invitations-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -107134,7 +107119,7 @@ export interface operations {
* @description Lists all of your social accounts.
*/
"users/list-social-accounts-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -107213,7 +107198,7 @@ export interface operations {
* @description Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)."
*/
"users/list-ssh-signing-keys-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -107315,7 +107300,7 @@ export interface operations {
* You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
*/
"activity/list-repos-starred-by-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
sort?: components["parameters"]["sort-starred"];
direction?: components["parameters"]["direction"];
@@ -107415,7 +107400,7 @@ export interface operations {
* @description Lists repositories the authenticated user is watching.
*/
"activity/list-watched-repos-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -107441,7 +107426,7 @@ export interface operations {
* @description List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token.
*/
"teams/list-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -107469,7 +107454,7 @@ export interface operations {
* Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.
*/
"users/list": {
- parameters?: {
+ parameters: {
query?: {
since?: components["parameters"]["since-user"];
per_page?: components["parameters"]["per-page"];
@@ -108379,7 +108364,7 @@ export interface operations {
* @description All branch protections were disabled for a repository.
*/
"branch-protection-configuration/disabled": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -108418,7 +108403,7 @@ export interface operations {
* @description All branch protections were enabled for a repository.
*/
"branch-protection-configuration/enabled": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -108455,7 +108440,7 @@ export interface operations {
* @description A branch protection rule was created.
*/
"branch-protection-rule/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -108492,7 +108477,7 @@ export interface operations {
* @description A branch protection rule was deleted.
*/
"branch-protection-rule/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -108529,7 +108514,7 @@ export interface operations {
* @description A branch protection rule was edited.
*/
"branch-protection-rule/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -108572,7 +108557,7 @@ export interface operations {
* @description A check run was completed, and a conclusion is available.
*/
"check-run/completed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -108616,7 +108601,7 @@ export interface operations {
* @description A new check run was created.
*/
"check-run/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -108660,7 +108645,7 @@ export interface operations {
* @description A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see "[Creating CI tests with the Checks API](https://docs.github.com/developers/apps/guides/creating-ci-tests-with-the-checks-api)."
*/
"check-run/requested-action": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -108704,7 +108689,7 @@ export interface operations {
* @description Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.
*/
"check-run/rerequested": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -108748,7 +108733,7 @@ export interface operations {
* @description All check runs in a check suite have completed, and a conclusion is available.
*/
"check-suite/completed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -108791,7 +108776,7 @@ export interface operations {
* @description Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/graphql/reference/mutations#createcheckrun) or "[Create a check run](https://docs.github.com/rest/checks/runs#create-a-check-run)" in the REST API documentation.
*/
"check-suite/requested": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -108834,7 +108819,7 @@ export interface operations {
* @description Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/graphql/reference/mutations#createchecksuite) or "[Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite)" in the REST API documentation.
*/
"check-suite/rerequested": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -108871,7 +108856,7 @@ export interface operations {
* @description A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.
*/
"code-scanning-alert/appeared-in-branch": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -108908,7 +108893,7 @@ export interface operations {
* @description Someone closed a code scanning alert.
*/
"code-scanning-alert/closed-by-user": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -108945,7 +108930,7 @@ export interface operations {
* @description A code scanning alert was created in a repository.
*/
"code-scanning-alert/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -108982,7 +108967,7 @@ export interface operations {
* @description A code scanning alert was fixed in a branch by a commit.
*/
"code-scanning-alert/fixed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109019,7 +109004,7 @@ export interface operations {
* @description A previously fixed code scanning alert reappeared in a branch.
*/
"code-scanning-alert/reopened": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109056,7 +109041,7 @@ export interface operations {
* @description Someone reopened a code scanning alert.
*/
"code-scanning-alert/reopened-by-user": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109095,7 +109080,7 @@ export interface operations {
* @description Someone commented on a commit.
*/
"commit-comment/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109135,7 +109120,7 @@ export interface operations {
* - Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.
*/
create: {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109174,7 +109159,7 @@ export interface operations {
* **Note**: This event will not occur when more than three tags are deleted at once.
*/
delete: {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109215,7 +109200,7 @@ export interface operations {
* @description A Dependabot alert was automatically closed.
*/
"dependabot-alert/auto-dismissed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109256,7 +109241,7 @@ export interface operations {
* @description A Dependabot alert was automatically reopened.
*/
"dependabot-alert/auto-reopened": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109297,7 +109282,7 @@ export interface operations {
* @description A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.
*/
"dependabot-alert/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109338,7 +109323,7 @@ export interface operations {
* @description A Dependabot alert was manually closed.
*/
"dependabot-alert/dismissed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109379,7 +109364,7 @@ export interface operations {
* @description A manifest file change removed a vulnerability.
*/
"dependabot-alert/fixed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109420,7 +109405,7 @@ export interface operations {
* @description A manifest file change introduced a vulnerable dependency that had previously been fixed.
*/
"dependabot-alert/reintroduced": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109461,7 +109446,7 @@ export interface operations {
* @description A Dependabot alert was manually reopened.
*/
"dependabot-alert/reopened": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109498,7 +109483,7 @@ export interface operations {
* @description A deploy key was created.
*/
"deploy-key/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109535,7 +109520,7 @@ export interface operations {
* @description A deploy key was deleted.
*/
"deploy-key/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109574,7 +109559,7 @@ export interface operations {
* @description A deployment was created.
*/
"deployment/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109611,7 +109596,7 @@ export interface operations {
* @description A deployment protection rule was requested for an environment.
*/
"deployment-protection-rule/requested": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109650,7 +109635,7 @@ export interface operations {
* @description A deployment review was approved.
*/
"deployment-review/approved": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109689,7 +109674,7 @@ export interface operations {
* @description A deployment review was rejected.
*/
"deployment-review/rejected": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109728,7 +109713,7 @@ export interface operations {
* @description A deployment review was requested.
*/
"deployment-review/requested": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109767,7 +109752,7 @@ export interface operations {
* @description A new deployment status was created.
*/
"deployment-status/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109808,7 +109793,7 @@ export interface operations {
* @description A comment on the discussion was marked as the answer.
*/
"discussion/answered": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109849,7 +109834,7 @@ export interface operations {
* @description The category of a discussion was changed.
*/
"discussion/category-changed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109890,7 +109875,7 @@ export interface operations {
* @description A discussion was closed.
*/
"discussion/closed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109931,7 +109916,7 @@ export interface operations {
* @description A comment on a discussion was created.
*/
"discussion-comment/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -109972,7 +109957,7 @@ export interface operations {
* @description A comment on a discussion was deleted.
*/
"discussion-comment/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110013,7 +109998,7 @@ export interface operations {
* @description A comment on a discussion was edited.
*/
"discussion-comment/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110054,7 +110039,7 @@ export interface operations {
* @description A discussion was created.
*/
"discussion/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110095,7 +110080,7 @@ export interface operations {
* @description A discussion was deleted.
*/
"discussion/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110136,7 +110121,7 @@ export interface operations {
* @description The title or body on a discussion was edited, or the category of the discussion was changed.
*/
"discussion/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110177,7 +110162,7 @@ export interface operations {
* @description A label was added to a discussion.
*/
"discussion/labeled": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110218,7 +110203,7 @@ export interface operations {
* @description A discussion was locked.
*/
"discussion/locked": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110259,7 +110244,7 @@ export interface operations {
* @description A discussion was pinned.
*/
"discussion/pinned": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110300,7 +110285,7 @@ export interface operations {
* @description A discussion was reopened.
*/
"discussion/reopened": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110341,7 +110326,7 @@ export interface operations {
* @description A discussion was transferred to another repository.
*/
"discussion/transferred": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110382,7 +110367,7 @@ export interface operations {
* @description A comment on the discussion was unmarked as the answer.
*/
"discussion/unanswered": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110423,7 +110408,7 @@ export interface operations {
* @description A label was removed from a discussion.
*/
"discussion/unlabeled": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110464,7 +110449,7 @@ export interface operations {
* @description A discussion was unlocked.
*/
"discussion/unlocked": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110505,7 +110490,7 @@ export interface operations {
* @description A discussion was unpinned.
*/
"discussion/unpinned": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110541,7 +110526,7 @@ export interface operations {
* To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
*/
fork: {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110580,7 +110565,7 @@ export interface operations {
* @description Someone revoked their authorization of a GitHub App.
*/
"github-app-authorization/revoked": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110616,7 +110601,7 @@ export interface operations {
* To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
*/
gollum: {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110653,7 +110638,7 @@ export interface operations {
* @description Someone installed a GitHub App on a user or organization account.
*/
"installation/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110690,7 +110675,7 @@ export interface operations {
* @description Someone uninstalled a GitHub App from their user or organization account.
*/
"installation/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110727,7 +110712,7 @@ export interface operations {
* @description Someone granted new permissions to a GitHub App.
*/
"installation/new-permissions-accepted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110764,7 +110749,7 @@ export interface operations {
* @description A GitHub App installation was granted access to one or more repositories.
*/
"installation-repositories/added": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110801,7 +110786,7 @@ export interface operations {
* @description Access to one or more repositories was revoked for a GitHub App installation.
*/
"installation-repositories/removed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110838,7 +110823,7 @@ export interface operations {
* @description Someone blocked access by a GitHub App to their user or organization account.
*/
"installation/suspend": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110873,7 +110858,7 @@ export interface operations {
* @description Somebody renamed the user or organization account that a GitHub App is installed on.
*/
"installation-target/renamed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110910,7 +110895,7 @@ export interface operations {
* @description A GitHub App that was blocked from accessing a user or organization account was given access the account again.
*/
"installation/unsuspend": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110949,7 +110934,7 @@ export interface operations {
* @description A comment on an issue or pull request was created.
*/
"issue-comment/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -110988,7 +110973,7 @@ export interface operations {
* @description A comment on an issue or pull request was deleted.
*/
"issue-comment/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111027,7 +111012,7 @@ export interface operations {
* @description A comment on an issue or pull request was edited.
*/
"issue-comment/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111066,7 +111051,7 @@ export interface operations {
* @description An issue was assigned to a user.
*/
"issues/assigned": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111105,7 +111090,7 @@ export interface operations {
* @description An issue was closed.
*/
"issues/closed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111144,7 +111129,7 @@ export interface operations {
* @description An issue was deleted.
*/
"issues/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111183,7 +111168,7 @@ export interface operations {
* @description An issue was removed from a milestone.
*/
"issues/demilestoned": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111222,7 +111207,7 @@ export interface operations {
* @description The title or body on an issue was edited.
*/
"issues/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111261,7 +111246,7 @@ export interface operations {
* @description A label was added to an issue.
*/
"issues/labeled": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111300,7 +111285,7 @@ export interface operations {
* @description Conversation on an issue was locked. For more information, see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)."
*/
"issues/locked": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111339,7 +111324,7 @@ export interface operations {
* @description An issue was added to a milestone.
*/
"issues/milestoned": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111378,7 +111363,7 @@ export interface operations {
* @description An issue was created. When a closed issue is reopened, the action will be `reopened` instead.
*/
"issues/opened": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111417,7 +111402,7 @@ export interface operations {
* @description An issue was pinned to a repository. For more information, see "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)."
*/
"issues/pinned": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111456,7 +111441,7 @@ export interface operations {
* @description A closed issue was reopened.
*/
"issues/reopened": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111495,7 +111480,7 @@ export interface operations {
* @description An issue was transferred to another repository. For more information, see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)."
*/
"issues/transferred": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111534,7 +111519,7 @@ export interface operations {
* @description A user was unassigned from an issue.
*/
"issues/unassigned": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111573,7 +111558,7 @@ export interface operations {
* @description A label was removed from an issue.
*/
"issues/unlabeled": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111612,7 +111597,7 @@ export interface operations {
* @description Conversation on an issue was locked. For more information, see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)."
*/
"issues/unlocked": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111651,7 +111636,7 @@ export interface operations {
* @description An issue was unpinned from a repository. For more information, see "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)."
*/
"issues/unpinned": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111690,7 +111675,7 @@ export interface operations {
* @description A label was created.
*/
"label/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111729,7 +111714,7 @@ export interface operations {
* @description A label was deleted.
*/
"label/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111768,7 +111753,7 @@ export interface operations {
* @description A label's name, description, or color was changed.
*/
"label/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111803,7 +111788,7 @@ export interface operations {
* @description Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.
*/
"marketplace-purchase/cancelled": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111838,7 +111823,7 @@ export interface operations {
* @description Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.
*/
"marketplace-purchase/changed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111873,7 +111858,7 @@ export interface operations {
* @description Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.
*/
"marketplace-purchase/pending-change": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111908,7 +111893,7 @@ export interface operations {
* @description Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.
*/
"marketplace-purchase/pending-change-cancelled": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111943,7 +111928,7 @@ export interface operations {
* @description Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.
*/
"marketplace-purchase/purchased": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -111980,7 +111965,7 @@ export interface operations {
* @description A GitHub user accepted an invitation to a repository.
*/
"member/added": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112017,7 +112002,7 @@ export interface operations {
* @description Permissions were changed for a collaborator on a repository.
*/
"member/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112054,7 +112039,7 @@ export interface operations {
* @description A collaborator was removed from a repository.
*/
"member/removed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112091,7 +112076,7 @@ export interface operations {
* @description An organization member was added to a team.
*/
"membership/added": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112128,7 +112113,7 @@ export interface operations {
* @description An organization member was removed from a team.
*/
"membership/removed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112167,7 +112152,7 @@ export interface operations {
* When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.
*/
"merge-group/checks-requested": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112206,7 +112191,7 @@ export interface operations {
* When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.
*/
"merge-group/destroyed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112243,7 +112228,7 @@ export interface operations {
* @description The webhook was deleted.
*/
"meta/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112282,7 +112267,7 @@ export interface operations {
* @description A milestone was closed.
*/
"milestone/closed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112321,7 +112306,7 @@ export interface operations {
* @description A milestone was created.
*/
"milestone/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112360,7 +112345,7 @@ export interface operations {
* @description A milestone was deleted.
*/
"milestone/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112399,7 +112384,7 @@ export interface operations {
* @description A milestone was edited.
*/
"milestone/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112438,7 +112423,7 @@ export interface operations {
* @description A milestone was opened.
*/
"milestone/opened": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112477,7 +112462,7 @@ export interface operations {
* @description A user was blocked from the organization.
*/
"org-block/blocked": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112516,7 +112501,7 @@ export interface operations {
* @description A previously blocked user was unblocked from the organization.
*/
"org-block/unblocked": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112555,7 +112540,7 @@ export interface operations {
* @description An organization was deleted.
*/
"organization/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112594,7 +112579,7 @@ export interface operations {
* @description A member accepted an invitation to join an organization.
*/
"organization/member-added": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112633,7 +112618,7 @@ export interface operations {
* @description A member was invited to join the organization.
*/
"organization/member-invited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112672,7 +112657,7 @@ export interface operations {
* @description A member was removed from the organization.
*/
"organization/member-removed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112711,7 +112696,7 @@ export interface operations {
* @description The name of an organization was changed.
*/
"organization/renamed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112748,7 +112733,7 @@ export interface operations {
* @description A package was published to a registry.
*/
"package/published": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112785,7 +112770,7 @@ export interface operations {
* @description A previously published package was updated.
*/
"package/updated": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112821,7 +112806,7 @@ export interface operations {
* To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission.
*/
"page-build": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112860,7 +112845,7 @@ export interface operations {
* @description A fine-grained personal access token request was approved.
*/
"personal-access-token-request/approved": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112899,7 +112884,7 @@ export interface operations {
* @description A fine-grained personal access token request was cancelled by the requester.
*/
"personal-access-token-request/cancelled": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112938,7 +112923,7 @@ export interface operations {
* @description A fine-grained personal access token request was created.
*/
"personal-access-token-request/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -112977,7 +112962,7 @@ export interface operations {
* @description A fine-grained personal access token request was denied.
*/
"personal-access-token-request/denied": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113009,7 +112994,7 @@ export interface operations {
};
/** This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly. */
ping: {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113049,7 +113034,7 @@ export interface operations {
* @description A note in a classic project was converted to an issue.
*/
"project-card/converted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113088,7 +113073,7 @@ export interface operations {
* @description A card was added to a classic project.
*/
"project-card/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113127,7 +113112,7 @@ export interface operations {
* @description A card on a classic project was deleted.
*/
"project-card/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113166,7 +113151,7 @@ export interface operations {
* @description A note on a classic project was edited.
*/
"project-card/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113205,7 +113190,7 @@ export interface operations {
* @description A card on a classic project was moved to another column or to another position in its column.
*/
"project-card/moved": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113244,7 +113229,7 @@ export interface operations {
* @description A classic project was closed.
*/
"project/closed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113283,7 +113268,7 @@ export interface operations {
* @description A column was added to a classic project.
*/
"project-column/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113322,7 +113307,7 @@ export interface operations {
* @description A column was deleted from a classic project.
*/
"project-column/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113361,7 +113346,7 @@ export interface operations {
* @description The name of a column on a classic project was changed.
*/
"project-column/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113400,7 +113385,7 @@ export interface operations {
* @description A column was moved to a new position on a classic project.
*/
"project-column/moved": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113439,7 +113424,7 @@ export interface operations {
* @description A classic project was created.
*/
"project/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113478,7 +113463,7 @@ export interface operations {
* @description A classic project was deleted.
*/
"project/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113517,7 +113502,7 @@ export interface operations {
* @description The name or description of a classic project was changed.
*/
"project/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113556,7 +113541,7 @@ export interface operations {
* @description A classic project was closed.
*/
"project/reopened": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113597,7 +113582,7 @@ export interface operations {
* @description A project in the organization was closed.
*/
"projects-v2/closed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113638,7 +113623,7 @@ export interface operations {
* @description A project in the organization was created.
*/
"projects-v2/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113679,7 +113664,7 @@ export interface operations {
* @description A project in the organization was deleted.
*/
"projects-v2/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113720,7 +113705,7 @@ export interface operations {
* @description The title, description, or README of a project in the organization was changed.
*/
"projects-v2/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113761,7 +113746,7 @@ export interface operations {
* @description An item on an organization project was archived. For more information, see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)."
*/
"projects-v2-item/archived": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113802,7 +113787,7 @@ export interface operations {
* @description A draft issue in an organization project was converted to an issue.
*/
"projects-v2-item/converted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113843,7 +113828,7 @@ export interface operations {
* @description An item was added to a project in the organization.
*/
"projects-v2-item/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113884,7 +113869,7 @@ export interface operations {
* @description An item was deleted from a project in the organization.
*/
"projects-v2-item/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113925,7 +113910,7 @@ export interface operations {
* @description The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.
*/
"projects-v2-item/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -113966,7 +113951,7 @@ export interface operations {
* @description The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.
*/
"projects-v2-item/reordered": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114007,7 +113992,7 @@ export interface operations {
* @description An archived item on an organization project was restored from the archive. For more information, see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)."
*/
"projects-v2-item/restored": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114048,7 +114033,7 @@ export interface operations {
* @description A project in the organization was reopened.
*/
"projects-v2/reopened": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114084,7 +114069,7 @@ export interface operations {
* To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.
*/
public: {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114123,7 +114108,7 @@ export interface operations {
* @description A pull request was assigned to a user.
*/
"pull-request/assigned": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114162,7 +114147,7 @@ export interface operations {
* @description Auto merge was disabled for a pull request. For more information, see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)."
*/
"pull-request/auto-merge-disabled": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114201,7 +114186,7 @@ export interface operations {
* @description Auto merge was enabled for a pull request. For more information, see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)."
*/
"pull-request/auto-merge-enabled": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114240,7 +114225,7 @@ export interface operations {
* @description A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.
*/
"pull-request/closed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114279,7 +114264,7 @@ export interface operations {
* @description A pull request was converted to a draft. For more information, see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)."
*/
"pull-request/converted-to-draft": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114318,7 +114303,7 @@ export interface operations {
* @description A pull request was removed from a milestone.
*/
"pull-request/demilestoned": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114357,7 +114342,7 @@ export interface operations {
* @description A pull request was removed from the merge queue.
*/
"pull-request/dequeued": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114396,7 +114381,7 @@ export interface operations {
* @description The title or body of a pull request was edited.
*/
"pull-request/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114435,7 +114420,7 @@ export interface operations {
* @description A pull request was added to the merge queue.
*/
"pull-request/enqueued": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114474,7 +114459,7 @@ export interface operations {
* @description A label was added to a pull request.
*/
"pull-request/labeled": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114513,7 +114498,7 @@ export interface operations {
* @description Conversation on a pull request was locked. For more information, see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)."
*/
"pull-request/locked": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114552,7 +114537,7 @@ export interface operations {
* @description A pull request was added to a milestone.
*/
"pull-request/milestoned": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114591,7 +114576,7 @@ export interface operations {
* @description A pull request was created
*/
"pull-request/opened": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114630,7 +114615,7 @@ export interface operations {
* @description A draft pull request was marked as ready for review. For more information, see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)."
*/
"pull-request/ready-for-review": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114669,7 +114654,7 @@ export interface operations {
* @description A previously closed pull request was reopened.
*/
"pull-request/reopened": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114708,7 +114693,7 @@ export interface operations {
* @description A comment on a pull request diff was created.
*/
"pull-request-review-comment/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114747,7 +114732,7 @@ export interface operations {
* @description A comment on a pull request diff was deleted.
*/
"pull-request-review-comment/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114786,7 +114771,7 @@ export interface operations {
* @description The content of a comment on a pull request diff was changed.
*/
"pull-request-review-comment/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114825,7 +114810,7 @@ export interface operations {
* @description A review on a pull request was dismissed.
*/
"pull-request-review/dismissed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114864,7 +114849,7 @@ export interface operations {
* @description The body comment on a pull request review was edited.
*/
"pull-request-review/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114903,7 +114888,7 @@ export interface operations {
* @description A request for review by a person or team was removed from a pull request.
*/
"pull-request/review-request-removed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114942,7 +114927,7 @@ export interface operations {
* @description Review by a person or team was requested for a pull request. For more information, see "[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)."
*/
"pull-request/review-requested": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -114981,7 +114966,7 @@ export interface operations {
* @description A review on a pull request was submitted.
*/
"pull-request-review/submitted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115020,7 +115005,7 @@ export interface operations {
* @description A comment thread on a pull request was marked as resolved.
*/
"pull-request-review-thread/resolved": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115059,7 +115044,7 @@ export interface operations {
* @description A previously resolved comment thread on a pull request was marked as unresolved.
*/
"pull-request-review-thread/unresolved": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115098,7 +115083,7 @@ export interface operations {
* @description A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.
*/
"pull-request/synchronize": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115137,7 +115122,7 @@ export interface operations {
* @description A user was unassigned from a pull request.
*/
"pull-request/unassigned": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115176,7 +115161,7 @@ export interface operations {
* @description A label was removed from a pull request.
*/
"pull-request/unlabeled": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115215,7 +115200,7 @@ export interface operations {
* @description Conversation on a pull request was unlocked. For more information, see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)."
*/
"pull-request/unlocked": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115255,7 +115240,7 @@ export interface operations {
* **Note**: An event will not be created when more than three tags are pushed at once.
*/
push: {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115294,7 +115279,7 @@ export interface operations {
* @description A package was published to a registry.
*/
"registry-package/published": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115333,7 +115318,7 @@ export interface operations {
* @description A package that was previously published to a registry was updated.
*/
"registry-package/updated": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115370,7 +115355,7 @@ export interface operations {
* @description A draft was saved, or a release or pre-release was published without previously being saved as a draft.
*/
"release/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115407,7 +115392,7 @@ export interface operations {
* @description A release, pre-release, or draft release was deleted.
*/
"release/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115444,7 +115429,7 @@ export interface operations {
* @description The details of a release, pre-release, or draft release were edited. For more information, see "[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)."
*/
"release/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115481,7 +115466,7 @@ export interface operations {
* @description A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.
*/
"release/prereleased": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115518,7 +115503,7 @@ export interface operations {
* @description A release, pre-release, or draft of a release was published.
*/
"release/published": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115555,7 +115540,7 @@ export interface operations {
* @description A release was published, or a pre-release was changed to a release.
*/
"release/released": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115592,7 +115577,7 @@ export interface operations {
* @description A release or pre-release was unpublished.
*/
"release/unpublished": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115629,7 +115614,7 @@ export interface operations {
* @description A repository security advisory was published.
*/
"repository-advisory/published": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115666,7 +115651,7 @@ export interface operations {
* @description A private vulnerability report was submitted.
*/
"repository-advisory/reported": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115703,7 +115688,7 @@ export interface operations {
* @description A repository was archived.
*/
"repository/archived": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115740,7 +115725,7 @@ export interface operations {
* @description A repository was created.
*/
"repository/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115777,7 +115762,7 @@ export interface operations {
* @description A repository was deleted. GitHub Apps and repository webhooks will not receive this event.
*/
"repository/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115814,7 +115799,7 @@ export interface operations {
* @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.
*/
"repository-dispatch/sample.collected": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115851,7 +115836,7 @@ export interface operations {
* @description The topics, default branch, description, or homepage of a repository was changed.
*/
"repository/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115883,7 +115868,7 @@ export interface operations {
};
/** This event occurs when a repository is imported to GitHub. For more information, see "[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports). */
"repository-import": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115920,7 +115905,7 @@ export interface operations {
* @description The visibility of a repository was changed to `private`.
*/
"repository/privatized": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115957,7 +115942,7 @@ export interface operations {
* @description The visibility of a repository was changed to `public`.
*/
"repository/publicized": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -115994,7 +115979,7 @@ export interface operations {
* @description The name of a repository was changed.
*/
"repository/renamed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116033,7 +116018,7 @@ export interface operations {
* @description A repository ruleset was created.
*/
"repository-ruleset/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116072,7 +116057,7 @@ export interface operations {
* @description A repository ruleset was deleted.
*/
"repository-ruleset/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116111,7 +116096,7 @@ export interface operations {
* @description A repository ruleset was edited.
*/
"repository-ruleset/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116148,7 +116133,7 @@ export interface operations {
* @description Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to "Repository" events.
*/
"repository/transferred": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116185,7 +116170,7 @@ export interface operations {
* @description A previously archived repository was unarchived.
*/
"repository/unarchived": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116222,7 +116207,7 @@ export interface operations {
* @description A repository vulnerability alert was created.
*/
"repository-vulnerability-alert/create": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116259,7 +116244,7 @@ export interface operations {
* @description A repository vulnerability alert was dismissed.
*/
"repository-vulnerability-alert/dismiss": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116296,7 +116281,7 @@ export interface operations {
* @description A previously dismissed or resolved repository vulnerability alert was reopened.
*/
"repository-vulnerability-alert/reopen": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116333,7 +116318,7 @@ export interface operations {
* @description A repository vulnerability alert was marked as resolved.
*/
"repository-vulnerability-alert/resolve": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116372,7 +116357,7 @@ export interface operations {
* @description A secret scanning alert was created.
*/
"secret-scanning-alert/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116413,7 +116398,7 @@ export interface operations {
* @description A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.
*/
"secret-scanning-alert-location/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116453,7 +116438,7 @@ export interface operations {
* @description A previously closed secret scanning alert was reopened.
*/
"secret-scanning-alert/reopened": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116492,7 +116477,7 @@ export interface operations {
* @description A secret scanning alert was closed.
*/
"secret-scanning-alert/resolved": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116531,7 +116516,7 @@ export interface operations {
* @description A secret scanning alert was marked as revoked.
*/
"secret-scanning-alert/revoked": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116568,7 +116553,7 @@ export interface operations {
* @description A security advisory was published to the GitHub community.
*/
"security-advisory/published": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116605,7 +116590,7 @@ export interface operations {
* @description The metadata or description of a security advisory was changed, or the security advisory was withdrawn.
*/
"security-advisory/updated": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116642,7 +116627,7 @@ export interface operations {
* @description A previously published security advisory was withdrawn.
*/
"security-advisory/withdrawn": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116678,7 +116663,7 @@ export interface operations {
* To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.
*/
"security-and-analysis": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116717,7 +116702,7 @@ export interface operations {
* This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.
*/
"sponsorship/cancelled": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116754,7 +116739,7 @@ export interface operations {
* @description A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.
*/
"sponsorship/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116791,7 +116776,7 @@ export interface operations {
* @description A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.
*/
"sponsorship/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116830,7 +116815,7 @@ export interface operations {
* This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.
*/
"sponsorship/pending-cancellation": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116867,7 +116852,7 @@ export interface operations {
* @description A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.
*/
"sponsorship/pending-tier-change": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116904,7 +116889,7 @@ export interface operations {
* @description A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.
*/
"sponsorship/tier-changed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116941,7 +116926,7 @@ export interface operations {
* @description Someone starred a repository.
*/
"star/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -116978,7 +116963,7 @@ export interface operations {
* @description Someone unstarred the repository.
*/
"star/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -117014,7 +116999,7 @@ export interface operations {
* To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission.
*/
status: {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -117053,7 +117038,7 @@ export interface operations {
* To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
*/
"team-add": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -117091,7 +117076,7 @@ export interface operations {
* @description A team was granted access to a repository.
*/
"team/added-to-repository": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -117129,7 +117114,7 @@ export interface operations {
* @description A team was created.
*/
"team/created": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -117167,7 +117152,7 @@ export interface operations {
* @description A team was deleted.
*/
"team/deleted": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -117205,7 +117190,7 @@ export interface operations {
* @description The name, description, or visibility of a team was changed.
*/
"team/edited": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -117243,7 +117228,7 @@ export interface operations {
* @description A team's access to a repository was removed.
*/
"team/removed-from-repository": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -117280,7 +117265,7 @@ export interface operations {
* @description Someone started watching the repository.
*/
"watch/started": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -117318,7 +117303,7 @@ export interface operations {
* To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
*/
"workflow-dispatch": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -117357,7 +117342,7 @@ export interface operations {
* @description A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.
*/
"workflow-job/completed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -117396,7 +117381,7 @@ export interface operations {
* @description A job in a workflow run started processing on a runner.
*/
"workflow-job/in-progress": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -117435,7 +117420,7 @@ export interface operations {
* @description A job in a workflow run was created.
*/
"workflow-job/queued": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -117474,7 +117459,7 @@ export interface operations {
* @description A job in a workflow run was created and is waiting for approvals.
*/
"workflow-job/waiting": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -117513,7 +117498,7 @@ export interface operations {
* @description A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.
*/
"workflow-run/completed": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -117552,7 +117537,7 @@ export interface operations {
* @description A workflow run started processing on a runner.
*/
"workflow-run/in-progress": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
@@ -117591,7 +117576,7 @@ export interface operations {
* @description A workflow run was triggered.
*/
"workflow-run/requested": {
- parameters?: {
+ parameters: {
header?: {
/** @example GitHub-Hookshot/123abc */
"User-Agent"?: string;
diff --git a/packages/openapi-typescript/examples/github-api-next.yaml b/packages/openapi-typescript/examples/github-api-next.yaml
index 0d1c05da1..e62e6d6e9 100644
--- a/packages/openapi-typescript/examples/github-api-next.yaml
+++ b/packages/openapi-typescript/examples/github-api-next.yaml
@@ -14507,7 +14507,6 @@ paths:
Re-run a job and its dependent jobs in a workflow run.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions:write` permission to use this endpoint.
tags:
- actions
@@ -14707,7 +14706,6 @@ paths:
Lists all organiation variables shared with a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -15032,7 +15030,6 @@ paths:
Lists all self-hosted runners configured in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15086,7 +15083,6 @@ paths:
Lists binaries for the runner application that you can download and run.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15122,7 +15118,6 @@ paths:
Generates a configuration that can be passed to the runner application at startup.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15190,17 +15185,20 @@ paths:
"/repos/{owner}/{repo}/actions/runners/registration-token":
post:
summary: Create a registration token for a repository
- description: "Returns a token that you can pass to the `config` script. The
- token\nexpires after one hour.\n\nYou must authenticate using an access token
- with the `repo` scope to use this endpoint.\nIf the repository is private,
- you must use an access token with the `repo` scope.\nGitHub Apps must have
- the `administration` permission for repositories and the `organization_self_hosted_runners`
- permission for organizations.\nAuthenticated users must have admin access
- to repositories or organizations, or the `manage_runners:enterprise` scope
- for enterprises, to use these endpoints.\n\nExample using registration token:
- \n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration
- token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts
- --token TOKEN```"
+ description: |-
+ Returns a token that you can pass to the `config` script. The token
+ expires after one hour.
+
+ You must authenticate using an access token with the `repo` scope to use this endpoint.
+ GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
+ Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+
+ Example using registration token:
+
+ Configure your self-hosted runner, replacing `TOKEN` with the registration token provided
+ by this endpoint.
+
+ ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```
tags:
- actions
operationId: actions/create-registration-token-for-repo
@@ -15233,7 +15231,6 @@ paths:
a repository. The token expires after one hour.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
@@ -15274,7 +15271,6 @@ paths:
Gets a specific self-hosted runner configured in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15308,7 +15304,6 @@ paths:
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15336,7 +15331,6 @@ paths:
Lists all labels for a self-hosted runner configured in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15365,7 +15359,6 @@ paths:
Add custom labels to a self-hosted runner configured in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15419,7 +15412,6 @@ paths:
self-hosted runner configured in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15474,7 +15466,6 @@ paths:
repository. Returns the remaining read-only labels from the runner.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15508,7 +15499,6 @@ paths:
present on the runner.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15888,7 +15878,6 @@ paths:
Cancels a workflow run using its `id`.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions:write` permission to use this endpoint.
tags:
- actions
@@ -15961,6 +15950,42 @@ paths:
previews: []
category: actions
subcategory: workflow-runs
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel":
+ post:
+ summary: Force cancel a workflow run
+ description: |-
+ Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.
+ You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).
+
+ You must authenticate using an access token with the `repo` scope to use this endpoint.
+ GitHub Apps must have the `actions:write` permission to use this endpoint.
+ tags:
+ - actions
+ operationId: actions/force-cancel-workflow-run
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run
+ parameters:
+ - "$ref": "#/components/parameters/owner"
+ - "$ref": "#/components/parameters/repo"
+ - "$ref": "#/components/parameters/run-id"
+ responses:
+ '202':
+ description: Response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/empty-object"
+ examples:
+ default:
+ value:
+ '409':
+ "$ref": "#/components/responses/conflict"
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: actions
+ subcategory: workflow-runs
"/repos/{owner}/{repo}/actions/runs/{run_id}/jobs":
get:
summary: List jobs for a workflow run
@@ -16522,7 +16547,6 @@ paths:
description: |-
Lists all repository variables.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -16570,7 +16594,6 @@ paths:
Creates a repository variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -16625,7 +16648,6 @@ paths:
Gets a specific variable in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -16659,7 +16681,6 @@ paths:
Updates a repository variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -16704,7 +16725,6 @@ paths:
Deletes a repository variable using the variable name.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -22922,10 +22942,8 @@ paths:
README, and CONTRIBUTING files.
The `health_percentage` score is defined as a percentage of how many of
- these four documents are present: README, CONTRIBUTING, LICENSE, and
- CODE_OF_CONDUCT. For example, if all four documents are present, then
- the `health_percentage` is `100`. If only one is present, then the
- `health_percentage` is `25`.
+ the recommended community health files are present. For more information, see
+ "[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)."
`content_reports_enabled` is only returned for organization-owned repositories.
tags:
@@ -35767,7 +35785,6 @@ paths:
Lists all environment variables.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `environments:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -35815,7 +35832,6 @@ paths:
Create an environment variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `environment:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -35870,7 +35886,6 @@ paths:
Gets a specific variable in an environment.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `environments:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -35904,7 +35919,6 @@ paths:
Updates an environment variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `environment:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -35949,7 +35963,6 @@ paths:
Deletes an environment variable using the variable name.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `environment:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -68432,7 +68445,7 @@ components:
- deletion
repository-rule-required-linear-history:
title: required_linear_history
- description: Prevent merge commits from being pushed to matching branches.
+ description: Prevent merge commits from being pushed to matching refs.
type: object
required:
- type
@@ -68444,7 +68457,7 @@ components:
repository-rule-required-deployments:
title: required_deployments
description: Choose which environments must be successfully deployed to before
- branches can be merged into a branch that matches this rule.
+ refs can be merged into a branch that matches this rule.
type: object
required:
- type
@@ -68466,7 +68479,7 @@ components:
- required_deployment_environments
repository-rule-required-signatures:
title: required_signatures
- description: Commits pushed to matching branches must have verified signatures.
+ description: Commits pushed to matching refs must have verified signatures.
type: object
required:
- type
@@ -68536,8 +68549,8 @@ components:
title: required_status_checks
description: Choose which status checks must pass before branches can be merged
into a branch that matches this rule. When enabled, commits must first be
- pushed to another branch, then merged or pushed directly to a branch that
- matches this rule after status checks have passed.
+ pushed to another branch, then merged or pushed directly to a ref that matches
+ this rule after status checks have passed.
type: object
required:
- type
@@ -68564,7 +68577,7 @@ components:
- strict_required_status_checks_policy
repository-rule-non-fast-forward:
title: non_fast_forward
- description: Prevent users with push access from force pushing to branches.
+ description: Prevent users with push access from force pushing to refs.
type: object
required:
- type
@@ -76775,6 +76788,12 @@ components:
type: string
examples:
- MDQ6R2F0ZTM3NTU=
+ prevent_self_review:
+ type: boolean
+ description: Whether deployments to this environment can be approved
+ by the user who created the deployment.
+ examples:
+ - false
type:
type: string
examples:
@@ -222552,6 +222571,7 @@ components:
wait_timer: 30
- id: 3755
node_id: MDQ6R2F0ZTM3NTU=
+ prevent_self_review: false
type: required_reviewers
reviewers:
- type: User
@@ -222611,6 +222631,7 @@ components:
wait_timer: 30
- id: 3755
node_id: MDQ6R2F0ZTM3NTU=
+ prevent_self_review: false
type: required_reviewers
reviewers:
- type: User
@@ -233626,7 +233647,8 @@ components:
"$ref": "#/components/schemas/code-scanning-analysis-tool-guid"
hook-id:
name: hook_id
- description: The unique identifier of the hook.
+ description: The unique identifier of the hook. You can find this value in the
+ `X-GitHub-Hook-ID` header of a webhook delivery.
in: path
required: true
schema:
diff --git a/packages/openapi-typescript/examples/github-api.ts b/packages/openapi-typescript/examples/github-api.ts
index bef9e453b..1f9b2be29 100644
--- a/packages/openapi-typescript/examples/github-api.ts
+++ b/packages/openapi-typescript/examples/github-api.ts
@@ -2610,7 +2610,6 @@ export interface paths {
* @description Re-run a job and its dependent jobs in a workflow run.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions:write` permission to use this endpoint.
*/
post: operations["actions/re-run-job-for-workflow-run"];
@@ -2649,7 +2648,6 @@ export interface paths {
* @description Lists all organiation variables shared with a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -2735,7 +2733,6 @@ export interface paths {
* @description Lists all self-hosted runners configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2747,7 +2744,6 @@ export interface paths {
* @description Lists binaries for the runner application that you can download and run.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2759,7 +2755,6 @@ export interface paths {
* @description Generates a configuration that can be passed to the runner application at startup.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2772,7 +2767,6 @@ export interface paths {
* expires after one hour.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*
@@ -2792,7 +2786,6 @@ export interface paths {
* a repository. The token expires after one hour.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*
@@ -2811,7 +2804,6 @@ export interface paths {
* @description Gets a specific self-hosted runner configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2821,7 +2813,6 @@ export interface paths {
* @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2833,7 +2824,6 @@ export interface paths {
* @description Lists all labels for a self-hosted runner configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2844,7 +2834,6 @@ export interface paths {
* self-hosted runner configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2854,7 +2843,6 @@ export interface paths {
* @description Add custom labels to a self-hosted runner configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2865,7 +2853,6 @@ export interface paths {
* repository. Returns the remaining read-only labels from the runner.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2881,7 +2868,6 @@ export interface paths {
* present on the runner.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -2966,7 +2952,6 @@ export interface paths {
* @description Cancels a workflow run using its `id`.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions:write` permission to use this endpoint.
*/
post: operations["actions/cancel-workflow-run"];
@@ -2984,6 +2969,17 @@ export interface paths {
*/
post: operations["actions/review-custom-gates-for-run"];
};
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": {
+ /**
+ * Force cancel a workflow run
+ * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.
+ * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).
+ *
+ * You must authenticate using an access token with the `repo` scope to use this endpoint.
+ * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ */
+ post: operations["actions/force-cancel-workflow-run"];
+ };
"/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": {
/**
* List jobs for a workflow run
@@ -3105,7 +3101,6 @@ export interface paths {
* List repository variables
* @description Lists all repository variables.
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -3115,7 +3110,6 @@ export interface paths {
* @description Creates a repository variable that you can reference in a GitHub Actions workflow.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -3127,7 +3121,6 @@ export interface paths {
* @description Gets a specific variable in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -3137,7 +3130,6 @@ export interface paths {
* @description Deletes a repository variable using the variable name.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -3147,7 +3139,6 @@ export interface paths {
* @description Updates a repository variable that you can reference in a GitHub Actions workflow.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -4287,10 +4278,8 @@ export interface paths {
* README, and CONTRIBUTING files.
*
* The `health_percentage` score is defined as a percentage of how many of
- * these four documents are present: README, CONTRIBUTING, LICENSE, and
- * CODE_OF_CONDUCT. For example, if all four documents are present, then
- * the `health_percentage` is `100`. If only one is present, then the
- * `health_percentage` is `25`.
+ * the recommended community health files are present. For more information, see
+ * "[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)."
*
* `content_reports_enabled` is only returned for organization-owned repositories.
*/
@@ -6482,7 +6471,6 @@ export interface paths {
* @description Lists all environment variables.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environments:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -6492,7 +6480,6 @@ export interface paths {
* @description Create an environment variable that you can reference in a GitHub Actions workflow.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environment:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -6504,7 +6491,6 @@ export interface paths {
* @description Gets a specific variable in an environment.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environments:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -6514,7 +6500,6 @@ export interface paths {
* @description Deletes an environment variable using the variable name.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environment:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -6524,7 +6509,6 @@ export interface paths {
* @description Updates an environment variable that you can reference in a GitHub Actions workflow.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environment:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -13660,7 +13644,7 @@ export interface components {
};
/**
* required_linear_history
- * @description Prevent merge commits from being pushed to matching branches.
+ * @description Prevent merge commits from being pushed to matching refs.
*/
"repository-rule-required-linear-history": {
/** @enum {string} */
@@ -13668,7 +13652,7 @@ export interface components {
};
/**
* required_deployments
- * @description Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
+ * @description Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
*/
"repository-rule-required-deployments": {
/** @enum {string} */
@@ -13680,7 +13664,7 @@ export interface components {
};
/**
* required_signatures
- * @description Commits pushed to matching branches must have verified signatures.
+ * @description Commits pushed to matching refs must have verified signatures.
*/
"repository-rule-required-signatures": {
/** @enum {string} */
@@ -13718,7 +13702,7 @@ export interface components {
};
/**
* required_status_checks
- * @description Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
+ * @description Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
*/
"repository-rule-required-status-checks": {
/** @enum {string} */
@@ -13732,7 +13716,7 @@ export interface components {
};
/**
* non_fast_forward
- * @description Prevent users with push access from force pushing to branches.
+ * @description Prevent users with push access from force pushing to refs.
*/
"repository-rule-non-fast-forward": {
/** @enum {string} */
@@ -19017,6 +19001,11 @@ export interface components {
id: number;
/** @example MDQ6R2F0ZTM3NTU= */
node_id: string;
+ /**
+ * @description Whether deployments to this environment can be approved by the user who created the deployment.
+ * @example false
+ */
+ prevent_self_review?: boolean;
/** @example required_reviewers */
type: string;
/** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */
@@ -83124,7 +83113,7 @@ export interface components {
"tool-name"?: components["schemas"]["code-scanning-analysis-tool-name"];
/** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */
"tool-guid"?: components["schemas"]["code-scanning-analysis-tool-guid"];
- /** @description The unique identifier of the hook. */
+ /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
"hook-id": number;
/** @description The unique identifier of the invitation. */
"invitation-id": number;
@@ -83353,7 +83342,7 @@ export interface operations {
* By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)."
*/
"security-advisories/list-global-advisories": {
- parameters?: {
+ parameters: {
query?: {
/** @description If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned. */
ghsa_id?: string;
@@ -83535,7 +83524,7 @@ export interface operations {
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*/
"apps/list-webhook-deliveries": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
cursor?: components["parameters"]["cursor"];
@@ -83599,7 +83588,7 @@ export interface operations {
* @description Lists all the pending installation requests for the authenticated GitHub App.
*/
"apps/list-installation-requests-for-authenticated-app": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -83623,7 +83612,7 @@ export interface operations {
* The permissions the installation has are included under the `permissions` key.
*/
"apps/list-installations": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -84021,7 +84010,7 @@ export interface operations {
* @description Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.
*/
"classroom/list-classrooms": {
- parameters?: {
+ parameters: {
query?: {
page?: components["parameters"]["page"];
per_page?: components["parameters"]["per-page"];
@@ -84212,7 +84201,7 @@ export interface operations {
* @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.
*/
"activity/list-public-events": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -84259,7 +84248,7 @@ export interface operations {
* @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:
*/
"gists/list": {
- parameters?: {
+ parameters: {
query?: {
since?: components["parameters"]["since"];
per_page?: components["parameters"]["per-page"];
@@ -84337,7 +84326,7 @@ export interface operations {
* Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.
*/
"gists/list-public": {
- parameters?: {
+ parameters: {
query?: {
since?: components["parameters"]["since"];
per_page?: components["parameters"]["per-page"];
@@ -84364,7 +84353,7 @@ export interface operations {
* @description List the authenticated user's starred gists:
*/
"gists/list-starred": {
- parameters?: {
+ parameters: {
query?: {
since?: components["parameters"]["since"];
per_page?: components["parameters"]["per-page"];
@@ -84802,7 +84791,7 @@ export interface operations {
* You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.
*/
"apps/list-repos-accessible-to-installation": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -84857,7 +84846,7 @@ export interface operations {
* request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
*/
"issues/list": {
- parameters?: {
+ parameters: {
query?: {
/** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */
filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all";
@@ -84896,7 +84885,7 @@ export interface operations {
* @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)."
*/
"licenses/get-all-commonly-used": {
- parameters?: {
+ parameters: {
query?: {
featured?: boolean;
per_page?: components["parameters"]["per-page"];
@@ -85029,7 +85018,7 @@ export interface operations {
* GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
*/
"apps/list-plans": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -85116,7 +85105,7 @@ export interface operations {
* GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
*/
"apps/list-plans-stubbed": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -85218,7 +85207,7 @@ export interface operations {
* @description List all notifications for the current user, sorted by most recently updated.
*/
"activity/list-notifications-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
all?: components["parameters"]["all"];
participating?: components["parameters"]["participating"];
@@ -85408,7 +85397,7 @@ export interface operations {
* @description Get the octocat as ASCII art
*/
"meta/get-octocat": {
- parameters?: {
+ parameters: {
query?: {
/** @description The words to show in Octocat's speech bubble */
s?: string;
@@ -85430,7 +85419,7 @@ export interface operations {
* **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.
*/
"orgs/list": {
- parameters?: {
+ parameters: {
query?: {
since?: components["parameters"]["since-org"];
per_page?: components["parameters"]["per-page"];
@@ -92792,7 +92781,6 @@ export interface operations {
* @description Re-run a job and its dependent jobs in a workflow run.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions:write` permission to use this endpoint.
*/
"actions/re-run-job-for-workflow-run": {
@@ -92923,7 +92911,6 @@ export interface operations {
* @description Lists all organiation variables shared with a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -93163,7 +93150,6 @@ export interface operations {
* @description Lists all self-hosted runners configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -93200,7 +93186,6 @@ export interface operations {
* @description Lists binaries for the runner application that you can download and run.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -93225,7 +93210,6 @@ export interface operations {
* @description Generates a configuration that can be passed to the runner application at startup.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -93265,7 +93249,6 @@ export interface operations {
* expires after one hour.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*
@@ -93298,7 +93281,6 @@ export interface operations {
* a repository. The token expires after one hour.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*
@@ -93330,7 +93312,6 @@ export interface operations {
* @description Gets a specific self-hosted runner configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -93356,7 +93337,6 @@ export interface operations {
* @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -93380,7 +93360,6 @@ export interface operations {
* @description Lists all labels for a self-hosted runner configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -93403,7 +93382,6 @@ export interface operations {
* self-hosted runner configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -93434,7 +93412,6 @@ export interface operations {
* @description Add custom labels to a self-hosted runner configured in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -93466,7 +93443,6 @@ export interface operations {
* repository. Returns the remaining read-only labels from the runner.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -93492,7 +93468,6 @@ export interface operations {
* present on the runner.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
* Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
*/
@@ -93767,7 +93742,6 @@ export interface operations {
* @description Cancels a workflow run using its `id`.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions:write` permission to use this endpoint.
*/
"actions/cancel-workflow-run": {
@@ -93818,6 +93792,32 @@ export interface operations {
};
};
};
+ /**
+ * Force cancel a workflow run
+ * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.
+ * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).
+ *
+ * You must authenticate using an access token with the `repo` scope to use this endpoint.
+ * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ */
+ "actions/force-cancel-workflow-run": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 202: {
+ content: {
+ "application/json": components["schemas"]["empty-object"];
+ };
+ };
+ 409: components["responses"]["conflict"];
+ };
+ };
/**
* List jobs for a workflow run
* @description Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
@@ -94209,7 +94209,6 @@ export interface operations {
* List repository variables
* @description Lists all repository variables.
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -94244,7 +94243,6 @@ export interface operations {
* @description Creates a repository variable that you can reference in a GitHub Actions workflow.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -94279,7 +94277,6 @@ export interface operations {
* @description Gets a specific variable in a repository.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -94305,7 +94302,6 @@ export interface operations {
* @description Deletes a repository variable using the variable name.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -94329,7 +94325,6 @@ export interface operations {
* @description Updates a repository variable that you can reference in a GitHub Actions workflow.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -98166,10 +98161,8 @@ export interface operations {
* README, and CONTRIBUTING files.
*
* The `health_percentage` score is defined as a percentage of how many of
- * these four documents are present: README, CONTRIBUTING, LICENSE, and
- * CODE_OF_CONDUCT. For example, if all four documents are present, then
- * the `health_percentage` is `100`. If only one is present, then the
- * `health_percentage` is `25`.
+ * the recommended community health files are present. For more information, see
+ * "[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)."
*
* `content_reports_enabled` is only returned for organization-owned repositories.
*/
@@ -106175,7 +106168,7 @@ export interface operations {
* - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.
*/
"repos/list-public": {
- parameters?: {
+ parameters: {
query?: {
since?: components["parameters"]["since-repo"];
};
@@ -106349,7 +106342,6 @@ export interface operations {
* @description Lists all environment variables.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environments:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -106384,7 +106376,6 @@ export interface operations {
* @description Create an environment variable that you can reference in a GitHub Actions workflow.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environment:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -106419,7 +106410,6 @@ export interface operations {
* @description Gets a specific variable in an environment.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environments:read` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -106445,7 +106435,6 @@ export interface operations {
* @description Deletes an environment variable using the variable name.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environment:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -106469,7 +106458,6 @@ export interface operations {
* @description Updates an environment variable that you can reference in a GitHub Actions workflow.
*
* You must authenticate using an access token with the `repo` scope to use this endpoint.
- * If the repository is private, you must use an access token with the `repo` scope.
* GitHub Apps must have the `environment:write` repository permission to use this endpoint.
* Authenticated users must have collaborator access to a repository to create, update, or read variables.
*/
@@ -107959,7 +107947,7 @@ export interface operations {
* @description List the users you've blocked on your personal account.
*/
"users/list-blocked-by-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -108056,7 +108044,7 @@ export interface operations {
* GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.
*/
"codespaces/list-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -108176,7 +108164,7 @@ export interface operations {
* GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.
*/
"codespaces/list-secrets-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -108746,7 +108734,7 @@ export interface operations {
* @description Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.
*/
"users/list-emails-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -108828,7 +108816,7 @@ export interface operations {
* @description Lists the people following the authenticated user.
*/
"users/list-followers-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -108854,7 +108842,7 @@ export interface operations {
* @description Lists the people who the authenticated user follows.
*/
"users/list-followed-by-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -108947,7 +108935,7 @@ export interface operations {
* @description Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
*/
"users/list-gpg-keys-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -109054,7 +109042,7 @@ export interface operations {
* You can find the permissions for the installation under the `permissions` key.
*/
"apps/list-installations-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -109227,7 +109215,7 @@ export interface operations {
* request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
*/
"issues/list-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
/** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */
filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all";
@@ -109261,7 +109249,7 @@ export interface operations {
* @description Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
*/
"users/list-public-ssh-keys-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -109364,7 +109352,7 @@ export interface operations {
* @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps).
*/
"apps/list-subscriptions-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -109390,7 +109378,7 @@ export interface operations {
* @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps).
*/
"apps/list-subscriptions-for-authenticated-user-stubbed": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -109415,7 +109403,7 @@ export interface operations {
* @description Lists all of the authenticated user's organization memberships.
*/
"orgs/list-memberships-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
/** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */
state?: "active" | "pending";
@@ -109498,7 +109486,7 @@ export interface operations {
* @description Lists all migrations a user has started.
*/
"migrations/list-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -109739,7 +109727,7 @@ export interface operations {
* This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response.
*/
"orgs/list-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -110009,7 +109997,7 @@ export interface operations {
* @description Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.
*/
"users/list-public-emails-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -110038,7 +110026,7 @@ export interface operations {
* The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
*/
"repos/list-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
/** @description Limit results to repositories with the specified visibility. */
visibility?: "all" | "public" | "private";
@@ -110247,7 +110235,7 @@ export interface operations {
* @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user.
*/
"repos/list-invitations-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -110310,7 +110298,7 @@ export interface operations {
* @description Lists all of your social accounts.
*/
"users/list-social-accounts-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -110395,7 +110383,7 @@ export interface operations {
* @description Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)."
*/
"users/list-ssh-signing-keys-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -110500,7 +110488,7 @@ export interface operations {
* You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
*/
"activity/list-repos-starred-by-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
sort?: components["parameters"]["sort-starred"];
direction?: components["parameters"]["direction"];
@@ -110600,7 +110588,7 @@ export interface operations {
* @description Lists repositories the authenticated user is watching.
*/
"activity/list-watched-repos-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -110626,7 +110614,7 @@ export interface operations {
* @description List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token.
*/
"teams/list-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -110654,7 +110642,7 @@ export interface operations {
* Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.
*/
"users/list": {
- parameters?: {
+ parameters: {
query?: {
since?: components["parameters"]["since-user"];
per_page?: components["parameters"]["per-page"];
diff --git a/packages/openapi-typescript/examples/github-api.yaml b/packages/openapi-typescript/examples/github-api.yaml
index bec7541fc..bf4e201a6 100644
--- a/packages/openapi-typescript/examples/github-api.yaml
+++ b/packages/openapi-typescript/examples/github-api.yaml
@@ -14456,7 +14456,6 @@ paths:
Re-run a job and its dependent jobs in a workflow run.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions:write` permission to use this endpoint.
tags:
- actions
@@ -14655,7 +14654,6 @@ paths:
Lists all organiation variables shared with a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -14980,7 +14978,6 @@ paths:
Lists all self-hosted runners configured in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15034,7 +15031,6 @@ paths:
Lists binaries for the runner application that you can download and run.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15070,7 +15066,6 @@ paths:
Generates a configuration that can be passed to the runner application at startup.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15138,17 +15133,20 @@ paths:
"/repos/{owner}/{repo}/actions/runners/registration-token":
post:
summary: Create a registration token for a repository
- description: "Returns a token that you can pass to the `config` script. The
- token\nexpires after one hour.\n\nYou must authenticate using an access token
- with the `repo` scope to use this endpoint.\nIf the repository is private,
- you must use an access token with the `repo` scope.\nGitHub Apps must have
- the `administration` permission for repositories and the `organization_self_hosted_runners`
- permission for organizations.\nAuthenticated users must have admin access
- to repositories or organizations, or the `manage_runners:enterprise` scope
- for enterprises, to use these endpoints.\n\nExample using registration token:
- \n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration
- token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts
- --token TOKEN```"
+ description: |-
+ Returns a token that you can pass to the `config` script. The token
+ expires after one hour.
+
+ You must authenticate using an access token with the `repo` scope to use this endpoint.
+ GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
+ Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
+
+ Example using registration token:
+
+ Configure your self-hosted runner, replacing `TOKEN` with the registration token provided
+ by this endpoint.
+
+ ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```
tags:
- actions
operationId: actions/create-registration-token-for-repo
@@ -15181,7 +15179,6 @@ paths:
a repository. The token expires after one hour.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
@@ -15222,7 +15219,6 @@ paths:
Gets a specific self-hosted runner configured in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15256,7 +15252,6 @@ paths:
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15284,7 +15279,6 @@ paths:
Lists all labels for a self-hosted runner configured in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15313,7 +15307,6 @@ paths:
Add custom labels to a self-hosted runner configured in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15367,7 +15360,6 @@ paths:
self-hosted runner configured in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15422,7 +15414,6 @@ paths:
repository. Returns the remaining read-only labels from the runner.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15456,7 +15447,6 @@ paths:
present on the runner.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
tags:
@@ -15836,7 +15826,6 @@ paths:
Cancels a workflow run using its `id`.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions:write` permission to use this endpoint.
tags:
- actions
@@ -15909,6 +15898,42 @@ paths:
previews: []
category: actions
subcategory: workflow-runs
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel":
+ post:
+ summary: Force cancel a workflow run
+ description: |-
+ Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.
+ You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).
+
+ You must authenticate using an access token with the `repo` scope to use this endpoint.
+ GitHub Apps must have the `actions:write` permission to use this endpoint.
+ tags:
+ - actions
+ operationId: actions/force-cancel-workflow-run
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run
+ parameters:
+ - "$ref": "#/components/parameters/owner"
+ - "$ref": "#/components/parameters/repo"
+ - "$ref": "#/components/parameters/run-id"
+ responses:
+ '202':
+ description: Response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/empty-object"
+ examples:
+ default:
+ value:
+ '409':
+ "$ref": "#/components/responses/conflict"
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: actions
+ subcategory: workflow-runs
"/repos/{owner}/{repo}/actions/runs/{run_id}/jobs":
get:
summary: List jobs for a workflow run
@@ -16465,7 +16490,6 @@ paths:
description: |-
Lists all repository variables.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -16513,7 +16537,6 @@ paths:
Creates a repository variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -16568,7 +16591,6 @@ paths:
Gets a specific variable in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -16602,7 +16624,6 @@ paths:
Updates a repository variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -16647,7 +16668,6 @@ paths:
Deletes a repository variable using the variable name.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -22852,10 +22872,8 @@ paths:
README, and CONTRIBUTING files.
The `health_percentage` score is defined as a percentage of how many of
- these four documents are present: README, CONTRIBUTING, LICENSE, and
- CODE_OF_CONDUCT. For example, if all four documents are present, then
- the `health_percentage` is `100`. If only one is present, then the
- `health_percentage` is `25`.
+ the recommended community health files are present. For more information, see
+ "[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)."
`content_reports_enabled` is only returned for organization-owned repositories.
tags:
@@ -35640,7 +35658,6 @@ paths:
Lists all environment variables.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `environments:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -35688,7 +35705,6 @@ paths:
Create an environment variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `environment:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -35743,7 +35759,6 @@ paths:
Gets a specific variable in an environment.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `environments:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -35777,7 +35792,6 @@ paths:
Updates an environment variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `environment:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -35822,7 +35836,6 @@ paths:
Deletes an environment variable using the variable name.
You must authenticate using an access token with the `repo` scope to use this endpoint.
- If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `environment:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
tags:
@@ -67948,7 +67961,7 @@ components:
- deletion
repository-rule-required-linear-history:
title: required_linear_history
- description: Prevent merge commits from being pushed to matching branches.
+ description: Prevent merge commits from being pushed to matching refs.
type: object
required:
- type
@@ -67960,7 +67973,7 @@ components:
repository-rule-required-deployments:
title: required_deployments
description: Choose which environments must be successfully deployed to before
- branches can be merged into a branch that matches this rule.
+ refs can be merged into a branch that matches this rule.
type: object
required:
- type
@@ -67982,7 +67995,7 @@ components:
- required_deployment_environments
repository-rule-required-signatures:
title: required_signatures
- description: Commits pushed to matching branches must have verified signatures.
+ description: Commits pushed to matching refs must have verified signatures.
type: object
required:
- type
@@ -68052,8 +68065,8 @@ components:
title: required_status_checks
description: Choose which status checks must pass before branches can be merged
into a branch that matches this rule. When enabled, commits must first be
- pushed to another branch, then merged or pushed directly to a branch that
- matches this rule after status checks have passed.
+ pushed to another branch, then merged or pushed directly to a ref that matches
+ this rule after status checks have passed.
type: object
required:
- type
@@ -68080,7 +68093,7 @@ components:
- strict_required_status_checks_policy
repository-rule-non-fast-forward:
title: non_fast_forward
- description: Prevent users with push access from force pushing to branches.
+ description: Prevent users with push access from force pushing to refs.
type: object
required:
- type
@@ -76408,6 +76421,11 @@ components:
node_id:
type: string
example: MDQ6R2F0ZTM3NTU=
+ prevent_self_review:
+ type: boolean
+ example: false
+ description: Whether deployments to this environment can be approved
+ by the user who created the deployment.
type:
type: string
example: required_reviewers
@@ -219013,6 +219031,7 @@ components:
wait_timer: 30
- id: 3755
node_id: MDQ6R2F0ZTM3NTU=
+ prevent_self_review: false
type: required_reviewers
reviewers:
- type: User
@@ -219072,6 +219091,7 @@ components:
wait_timer: 30
- id: 3755
node_id: MDQ6R2F0ZTM3NTU=
+ prevent_self_review: false
type: required_reviewers
reviewers:
- type: User
@@ -230087,7 +230107,8 @@ components:
"$ref": "#/components/schemas/code-scanning-analysis-tool-guid"
hook-id:
name: hook_id
- description: The unique identifier of the hook.
+ description: The unique identifier of the hook. You can find this value in the
+ `X-GitHub-Hook-ID` header of a webhook delivery.
in: path
required: true
schema:
diff --git a/packages/openapi-typescript/examples/octokit-ghes-3.6-diff-to-api.ts b/packages/openapi-typescript/examples/octokit-ghes-3.6-diff-to-api.ts
index c680e13ef..2a9ccd3a2 100644
--- a/packages/openapi-typescript/examples/octokit-ghes-3.6-diff-to-api.ts
+++ b/packages/openapi-typescript/examples/octokit-ghes-3.6-diff-to-api.ts
@@ -5815,7 +5815,7 @@ export interface operations {
/** List global webhooks */
"enterprise-admin/list-global-webhooks": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -5962,7 +5962,7 @@ export interface operations {
};
/** List public keys */
"enterprise-admin/list-public-keys": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -6143,7 +6143,7 @@ export interface operations {
};
/** List pre-receive environments */
"enterprise-admin/list-pre-receive-environments": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -6335,7 +6335,7 @@ export interface operations {
};
/** List pre-receive hooks */
"enterprise-admin/list-pre-receive-hooks": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -6459,7 +6459,7 @@ export interface operations {
* @description Lists personal access tokens for all users, including admin users.
*/
"enterprise-admin/list-personal-access-tokens": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -6623,7 +6623,7 @@ export interface operations {
* The permissions the installation has are included under the `permissions` key.
*/
"apps/list-installations": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -6714,7 +6714,7 @@ export interface operations {
* You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`.
*/
"oauth-authorizations/list-grants": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -6901,7 +6901,7 @@ export interface operations {
* @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).
*/
"oauth-authorizations/list-authorizations": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
@@ -9233,7 +9233,7 @@ export interface operations {
* - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.
*/
"repos/list-public": {
- parameters?: {
+ parameters: {
query?: {
since?: components["parameters"]["since-repo"];
/** @description Specifies the types of repositories to return. This endpoint will only list repositories available to all users on the enterprise. */
@@ -9908,7 +9908,7 @@ export interface operations {
* You can find the permissions for the installation under the `permissions` key.
*/
"apps/list-installations-for-authenticated-user": {
- parameters?: {
+ parameters: {
query?: {
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
diff --git a/packages/openapi-typescript/examples/stripe-api.ts b/packages/openapi-typescript/examples/stripe-api.ts
index e9f59c4d8..b462ccd76 100644
--- a/packages/openapi-typescript/examples/stripe-api.ts
+++ b/packages/openapi-typescript/examples/stripe-api.ts
@@ -323,7 +323,19 @@ export interface paths {
"/v1/charges/{charge}/refunds": {
/** @description You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.
*/
get: operations["GetChargesChargeRefunds"];
- /** @description Create a refund.
*/
+ /**
+ * @description When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
+ *
+ * Creating a new refund will refund a charge that has previously been created but not yet refunded.
+ * Funds will be refunded to the credit or debit card that was originally charged.
+ *
+ * You can optionally refund only part of a charge.
+ * You can do so multiple times, until the entire charge has been refunded.
+ *
+ * Once entirely refunded, a charge can’t be refunded again.
+ * This method will raise an error when called on an already-refunded charge,
+ * or when trying to refund more money than is left on a charge.
+ */
post: operations["PostChargesChargeRefunds"];
};
"/v1/charges/{charge}/refunds/{refund}": {
@@ -1209,32 +1221,32 @@ export interface paths {
post: operations["PostPaymentMethodsPaymentMethodDetach"];
};
"/v1/payouts": {
- /** @description Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.
*/
+ /** @description Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.
*/
get: operations["GetPayouts"];
/**
- * @description To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.
+ * @description To send funds to your own bank account, create a new payout object. Your Stripe balance must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.
*
- * If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.
+ * If your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode.
*
- * If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.
+ * If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The balance object details available and pending amounts by source type.
*/
post: operations["PostPayouts"];
};
"/v1/payouts/{payout}": {
- /** @description Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.
*/
+ /** @description Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.
*/
get: operations["GetPayoutsPayout"];
- /** @description Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.
*/
+ /** @description Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.
*/
post: operations["PostPayoutsPayout"];
};
"/v1/payouts/{payout}/cancel": {
- /** @description A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.
*/
+ /** @description You can cancel a previously created payout if it hasn’t been paid out yet. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.
*/
post: operations["PostPayoutsPayoutCancel"];
};
"/v1/payouts/{payout}/reverse": {
/**
- * @description Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.
+ * @description Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is in the pending status, use /v1/payouts/:id/cancel instead.
*
- * By requesting a reversal via /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.
+ * By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.
*/
post: operations["PostPayoutsPayoutReverse"];
};
@@ -1385,7 +1397,19 @@ export interface paths {
"/v1/refunds": {
/** @description Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.
*/
get: operations["GetRefunds"];
- /** @description Create a refund.
*/
+ /**
+ * @description When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
+ *
+ * Creating a new refund will refund a charge that has previously been created but not yet refunded.
+ * Funds will be refunded to the credit or debit card that was originally charged.
+ *
+ * You can optionally refund only part of a charge.
+ * You can do so multiple times, until the entire charge has been refunded.
+ *
+ * Once entirely refunded, a charge can’t be refunded again.
+ * This method will raise an error when called on an already-refunded charge,
+ * or when trying to refund more money than is left on a charge.
+ */
post: operations["PostRefunds"];
};
"/v1/refunds/{refund}": {
@@ -11189,21 +11213,21 @@ export interface components {
* @description A `Payout` object is created when you receive funds from Stripe, or when you
* initiate a payout to either a bank account or debit card of a [connected
* Stripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
- * as well as list all payouts. Payouts are made on [varying
+ * and list all payouts. Payouts are made on [varying
* schedules](/docs/connect/manage-payout-schedule), depending on your country and
* industry.
*
* Related guide: [Receiving payouts](https://stripe.com/docs/payouts)
*/
payout: {
- /** @description Amount (in cents (or local equivalent)) to be transferred to your bank account or debit card. */
+ /** @description The amount (in cents (or local equivalent)) that transfers to your bank account or debit card. */
amount: number;
/**
* Format: unix-time
- * @description Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays.
+ * @description Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.
*/
arrival_date: number;
- /** @description Returns `true` if the payout was created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule), and `false` if it was [requested manually](https://stripe.com/docs/payouts#manual-payouts). */
+ /** @description Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts). */
automatic: boolean;
/** @description ID of the balance transaction that describes the impact of this payout on your account balance. */
balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null;
@@ -11216,13 +11240,13 @@ export interface components {
currency: string;
/** @description An arbitrary string attached to the object. Often useful for displaying to users. */
description?: string | null;
- /** @description ID of the bank account or card the payout was sent to. */
+ /** @description ID of the bank account or card the payout is sent to. */
destination?: (string | components["schemas"]["bank_account"] | components["schemas"]["card"] | components["schemas"]["deleted_bank_account"] | components["schemas"]["deleted_card"]) | null;
- /** @description If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance. */
+ /** @description If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance. */
failure_balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null;
- /** @description Error code explaining reason for payout failure if available. See [Types of payout failures](https://stripe.com/docs/api#payout_failures) for a list of failure codes. */
+ /** @description Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures). */
failure_code?: string | null;
- /** @description Message to user further explaining reason for payout failure if available. */
+ /** @description Message that provides the reason for a payout failure, if available. */
failure_message?: string | null;
/** @description Unique identifier for the object. */
id: string;
@@ -11232,7 +11256,7 @@ export interface components {
metadata?: {
[key: string]: string;
} | null;
- /** @description The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. (See [Bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks) for more information.) */
+ /** @description The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks). */
method: string;
/**
* @description String representing the object's type. Objects of the same type share the same value.
@@ -11242,17 +11266,17 @@ export interface components {
/** @description If the payout reverses another, this is the ID of the original payout. */
original_payout?: (string | components["schemas"]["payout"]) | null;
/**
- * @description If `completed`, the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) may be used to list all Balance Transactions that were paid out in this payout.
+ * @description If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout.
* @enum {string}
*/
reconciliation_status: "completed" | "in_progress" | "not_applicable";
- /** @description If the payout was reversed, this is the ID of the payout that reverses this payout. */
+ /** @description If the payout reverses, this is the ID of the payout that reverses this payout. */
reversed_by?: (string | components["schemas"]["payout"]) | null;
- /** @description The source balance this payout came from. One of `card`, `fpx`, or `bank_account`. */
+ /** @description The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`. */
source_type: string;
- /** @description Extra information about a payout to be displayed on the user's bank statement. */
+ /** @description Extra information about a payout that displays on the user's bank statement. */
statement_descriptor?: string | null;
- /** @description Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it is submitted to the bank, when it becomes `in_transit`. The status then changes to `paid` if the transaction goes through, or to `failed` or `canceled` (within 5 business days). Some failed payouts may initially show as `paid` but then change to `failed`. */
+ /** @description Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`. */
status: string;
/**
* @description Can be `bank_account` or `card`.
@@ -16507,7 +16531,7 @@ export interface operations {
/** @description Retrieves the details of an account.
*/
GetAccount: {
- parameters?: {
+ parameters: {
query?: {
/** @description Specifies which fields in the response should be expanded. */
expand?: string[];
@@ -16613,7 +16637,7 @@ export interface operations {
};
/** @description Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.
*/
GetAccounts: {
- parameters?: {
+ parameters: {
query?: {
created?: {
gt?: number;
@@ -19269,7 +19293,7 @@ export interface operations {
};
/** @description List apple pay domains.
*/
GetApplePayDomains: {
- parameters?: {
+ parameters: {
query?: {
domain_name?: string;
/** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */
@@ -19399,7 +19423,7 @@ export interface operations {
};
/** @description Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.
*/
GetApplicationFees: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return application fees for the charge specified by this charge ID. */
charge?: string;
@@ -19849,7 +19873,7 @@ export interface operations {
* For a sample request, see Accounting for negative balances.
*/
GetBalance: {
- parameters?: {
+ parameters: {
query?: {
/** @description Specifies which fields in the response should be expanded. */
expand?: string[];
@@ -19881,7 +19905,7 @@ export interface operations {
* Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
*/
GetBalanceHistory: {
- parameters?: {
+ parameters: {
query?: {
created?: {
gt?: number;
@@ -19979,7 +20003,7 @@ export interface operations {
* Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
*/
GetBalanceTransactions: {
- parameters?: {
+ parameters: {
query?: {
created?: {
gt?: number;
@@ -20073,7 +20097,7 @@ export interface operations {
};
/** @description Returns a list of configurations that describe the functionality of the customer portal.
*/
GetBillingPortalConfigurations: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations). */
active?: boolean;
@@ -20437,7 +20461,7 @@ export interface operations {
};
/** @description Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.
*/
GetCharges: {
- parameters?: {
+ parameters: {
query?: {
created?: {
gt?: number;
@@ -20959,12 +20983,14 @@ export interface operations {
PostChargesChargeRefund: {
parameters: {
path: {
+ /** @description The identifier of the charge to refund. */
charge: string;
};
};
requestBody?: {
content: {
"application/x-www-form-urlencoded": {
+ /** @description A positive integer in cents (or local equivalent) representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge. */
amount?: number;
/** @description Specifies which fields in the response should be expanded. */
expand?: string[];
@@ -20974,10 +21000,16 @@ export interface operations {
metadata?: {
[key: string]: string;
} | "";
+ /** @description The identifier of the PaymentIntent to refund. */
payment_intent?: string;
- /** @enum {string} */
+ /**
+ * @description String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms.
+ * @enum {string}
+ */
reason?: "duplicate" | "fraudulent" | "requested_by_customer";
+ /** @description Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge. */
refund_application_fee?: boolean;
+ /** @description Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).
A transfer can be reversed only by the application that created the charge. */
reverse_transfer?: boolean;
};
};
@@ -21046,17 +21078,29 @@ export interface operations {
};
};
};
- /** @description Create a refund.
*/
+ /**
+ * @description When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
+ *
+ * Creating a new refund will refund a charge that has previously been created but not yet refunded.
+ * Funds will be refunded to the credit or debit card that was originally charged.
+ *
+ * You can optionally refund only part of a charge.
+ * You can do so multiple times, until the entire charge has been refunded.
+ *
+ * Once entirely refunded, a charge can’t be refunded again.
+ * This method will raise an error when called on an already-refunded charge,
+ * or when trying to refund more money than is left on a charge.
+ */
PostChargesChargeRefunds: {
parameters: {
path: {
+ /** @description The identifier of the charge to refund. */
charge: string;
};
};
requestBody?: {
content: {
"application/x-www-form-urlencoded": {
- /** @description A positive integer representing how much to refund. */
amount?: number;
/** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */
currency?: string;
@@ -21075,10 +21119,16 @@ export interface operations {
* @enum {string}
*/
origin?: "customer_balance";
+ /** @description The identifier of the PaymentIntent to refund. */
payment_intent?: string;
- /** @enum {string} */
+ /**
+ * @description String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms.
+ * @enum {string}
+ */
reason?: "duplicate" | "fraudulent" | "requested_by_customer";
+ /** @description Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge. */
refund_application_fee?: boolean;
+ /** @description Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).
A transfer can be reversed only by the application that created the charge. */
reverse_transfer?: boolean;
};
};
@@ -21166,7 +21216,7 @@ export interface operations {
};
/** @description Returns a list of Checkout Sessions.
*/
GetCheckoutSessions: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return the Checkout Sessions for the Customer specified. */
customer?: string;
@@ -21982,7 +22032,7 @@ export interface operations {
};
/** @description Lists all Country Spec objects available in the API.
*/
GetCountrySpecs: {
- parameters?: {
+ parameters: {
query?: {
/** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */
ending_before?: string;
@@ -22058,7 +22108,7 @@ export interface operations {
};
/** @description Returns a list of your coupons.
*/
GetCoupons: {
- parameters?: {
+ parameters: {
query?: {
/** @description A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. */
created?: {
@@ -22280,7 +22330,7 @@ export interface operations {
};
/** @description Returns a list of credit notes.
*/
GetCreditNotes: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return credit notes for the customer specified by this customer ID. */
customer?: string;
@@ -22715,7 +22765,7 @@ export interface operations {
};
/** @description Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
*/
GetCustomers: {
- parameters?: {
+ parameters: {
query?: {
created?: {
gt?: number;
@@ -25345,7 +25395,7 @@ export interface operations {
};
/** @description Returns a list of your disputes.
*/
GetDisputes: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return disputes associated to the charge specified by this charge ID. */
charge?: string;
@@ -25601,7 +25651,7 @@ export interface operations {
};
/** @description List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).
*/
GetEvents: {
- parameters?: {
+ parameters: {
query?: {
created?: {
gt?: number;
@@ -25689,7 +25739,7 @@ export interface operations {
};
/** @description Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.
*/
GetExchangeRates: {
- parameters?: {
+ parameters: {
query?: {
/** @description A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */
ending_before?: string;
@@ -25765,7 +25815,7 @@ export interface operations {
};
/** @description Returns a list of file links.
*/
GetFileLinks: {
- parameters?: {
+ parameters: {
query?: {
created?: {
gt?: number;
@@ -25924,7 +25974,7 @@ export interface operations {
};
/** @description Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.
*/
GetFiles: {
- parameters?: {
+ parameters: {
query?: {
created?: {
gt?: number;
@@ -26059,7 +26109,7 @@ export interface operations {
};
/** @description Returns a list of Financial Connections Account objects.
*/
GetFinancialConnectionsAccounts: {
- parameters?: {
+ parameters: {
query?: {
/** @description If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive. */
account_holder?: {
@@ -26339,7 +26389,7 @@ export interface operations {
};
/** @description List all verification reports.
*/
GetIdentityVerificationReports: {
- parameters?: {
+ parameters: {
query?: {
created?: {
gt?: number;
@@ -26425,7 +26475,7 @@ export interface operations {
};
/** @description Returns a list of VerificationSessions
*/
GetIdentityVerificationSessions: {
- parameters?: {
+ parameters: {
query?: {
created?: {
gt?: number;
@@ -26710,7 +26760,7 @@ export interface operations {
};
/** @description Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.
*/
GetInvoiceitems: {
- parameters?: {
+ parameters: {
query?: {
created?: {
gt?: number;
@@ -27004,7 +27054,7 @@ export interface operations {
};
/** @description You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.
*/
GetInvoices: {
- parameters?: {
+ parameters: {
query?: {
/** @description The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. */
collection_method?: "charge_automatically" | "send_invoice";
@@ -27378,7 +27428,7 @@ export interface operations {
* You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.
*/
GetInvoicesUpcoming: {
- parameters?: {
+ parameters: {
query?: {
/** @description Settings for automatic tax lookup for this invoice preview. */
automatic_tax?: {
@@ -27554,7 +27604,7 @@ export interface operations {
};
/** @description When retrieving an upcoming invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
*/
GetInvoicesUpcomingLines: {
- parameters?: {
+ parameters: {
query?: {
/** @description Settings for automatic tax lookup for this invoice preview. */
automatic_tax?: {
@@ -28259,7 +28309,7 @@ export interface operations {
};
/** @description Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
*/
GetIssuingAuthorizations: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return authorizations that belong to the given card. */
card?: string;
@@ -28458,7 +28508,7 @@ export interface operations {
};
/** @description Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
*/
GetIssuingCardholders: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return cardholders that were created during the given date interval. */
created?: {
@@ -28785,7 +28835,7 @@ export interface operations {
};
/** @description Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
*/
GetIssuingCards: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return cards belonging to the Cardholder with the provided ID. */
cardholder?: string;
@@ -29036,7 +29086,7 @@ export interface operations {
};
/** @description Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
*/
GetIssuingDisputes: {
- parameters?: {
+ parameters: {
query?: {
/** @description Select Issuing disputes that were created during the given date interval. */
created?: {
@@ -29363,7 +29413,7 @@ export interface operations {
};
/** @description Returns a list of Issuing Settlement objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
*/
GetIssuingSettlements: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return issuing settlements that were created during the given date interval. */
created?: {
@@ -29480,7 +29530,7 @@ export interface operations {
};
/** @description Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
*/
GetIssuingTransactions: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return transactions that belong to the given card. */
card?: string;
@@ -29686,7 +29736,7 @@ export interface operations {
};
/** @description Returns a list of Financial Connections Account objects.
*/
GetLinkedAccounts: {
- parameters?: {
+ parameters: {
query?: {
/** @description If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive. */
account_holder?: {
@@ -29914,7 +29964,7 @@ export interface operations {
};
/** @description Returns a list of PaymentIntents.
*/
GetPaymentIntents: {
- parameters?: {
+ parameters: {
query?: {
/** @description A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. */
created?: {
@@ -31876,7 +31926,7 @@ export interface operations {
};
/** @description Returns a list of your payment links.
*/
GetPaymentLinks: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links). */
active?: boolean;
@@ -32400,7 +32450,7 @@ export interface operations {
};
/** @description List payment method configurations
*/
GetPaymentMethodConfigurations: {
- parameters?: {
+ parameters: {
query?: {
/** @description The Connect application to filter by. */
application?: string | "";
@@ -33261,7 +33311,7 @@ export interface operations {
};
/** @description Lists the details of existing payment method domains.
*/
GetPaymentMethodDomains: {
- parameters?: {
+ parameters: {
query?: {
/** @description The domain name that this payment method domain object represents. */
domain_name?: string;
@@ -33439,7 +33489,7 @@ export interface operations {
};
/** @description Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.
*/
GetPaymentMethods: {
- parameters?: {
+ parameters: {
query?: {
/** @description The ID of the customer whose PaymentMethods will be retrieved. */
customer?: string;
@@ -33939,9 +33989,9 @@ export interface operations {
};
};
};
- /** @description Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.
*/
+ /** @description Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.
*/
GetPayouts: {
- parameters?: {
+ parameters: {
query?: {
arrival_date?: {
gt?: number;
@@ -34001,11 +34051,11 @@ export interface operations {
};
};
/**
- * @description To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.
+ * @description To send funds to your own bank account, create a new payout object. Your Stripe balance must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.
*
- * If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.
+ * If your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode.
*
- * If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.
+ * If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The balance object details available and pending amounts by source type.
*/
PostPayouts: {
requestBody: {
@@ -34017,7 +34067,7 @@ export interface operations {
currency: string;
/** @description An arbitrary string attached to the object. Often useful for displaying to users. */
description?: string;
- /** @description The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used. */
+ /** @description The ID of a bank account or a card to send the payout to. If you don't provide a destination, we use the default external account for the specified currency. */
destination?: string;
/** @description Specifies which fields in the response should be expanded. */
expand?: string[];
@@ -34026,16 +34076,16 @@ export interface operations {
[key: string]: string;
};
/**
- * @description The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. (See [Bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks) for more information.)
+ * @description The method used to send this payout, which is `standard` or `instant`. We support `instant` for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).
* @enum {string}
*/
method?: "instant" | "standard";
/**
- * @description The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. One of `bank_account`, `card`, or `fpx`.
+ * @description The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`.
* @enum {string}
*/
source_type?: "bank_account" | "card" | "fpx";
- /** @description A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a `statement_descriptor` longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all. */
+ /** @description A string that displays on the recipient's bank or card statement (up to 22 characters). A `statement_descriptor` that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all. */
statement_descriptor?: string;
};
};
@@ -34055,7 +34105,7 @@ export interface operations {
};
};
};
- /** @description Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.
*/
+ /** @description Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.
*/
GetPayoutsPayout: {
parameters: {
query?: {
@@ -34086,7 +34136,7 @@ export interface operations {
};
};
};
- /** @description Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.
*/
+ /** @description Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.
*/
PostPayoutsPayout: {
parameters: {
path: {
@@ -34120,7 +34170,7 @@ export interface operations {
};
};
};
- /** @description A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.
*/
+ /** @description You can cancel a previously created payout if it hasn’t been paid out yet. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.
*/
PostPayoutsPayoutCancel: {
parameters: {
path: {
@@ -34151,9 +34201,9 @@ export interface operations {
};
};
/**
- * @description Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.
+ * @description Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is in the pending status, use /v1/payouts/:id/cancel instead.
*
- * By requesting a reversal via /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.
+ * By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.
*/
PostPayoutsPayoutReverse: {
parameters: {
@@ -34190,7 +34240,7 @@ export interface operations {
};
/** @description Returns a list of your plans.
*/
GetPlans: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans). */
active?: boolean;
@@ -34450,7 +34500,7 @@ export interface operations {
};
/** @description Returns a list of your prices.
*/
GetPrices: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices). */
active?: boolean;
@@ -34821,7 +34871,7 @@ export interface operations {
};
/** @description Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
*/
GetProducts: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return products that are active or inactive (e.g., pass `false` to list all inactive products). */
active?: boolean;
@@ -35172,7 +35222,7 @@ export interface operations {
};
/** @description Returns a list of your promotion codes.
*/
GetPromotionCodes: {
- parameters?: {
+ parameters: {
query?: {
/** @description Filter promotion codes by whether they are active. */
active?: boolean;
@@ -35368,7 +35418,7 @@ export interface operations {
};
/** @description Returns a list of your quotes.
*/
GetQuotes: {
- parameters?: {
+ parameters: {
query?: {
/** @description The ID of the customer whose quotes will be retrieved. */
customer?: string;
@@ -35912,7 +35962,7 @@ export interface operations {
};
/** @description Returns a list of early fraud warnings.
*/
GetRadarEarlyFraudWarnings: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return early fraud warnings for the charge specified by this charge ID. */
charge?: string;
@@ -36138,7 +36188,7 @@ export interface operations {
};
/** @description Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
*/
GetRadarValueLists: {
- parameters?: {
+ parameters: {
query?: {
/** @description The alias used to reference the value list when writing rules. */
alias?: string;
@@ -36327,7 +36377,7 @@ export interface operations {
};
/** @description Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.
*/
GetRefunds: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return refunds for the charge specified by this charge ID. */
charge?: string;
@@ -36380,13 +36430,25 @@ export interface operations {
};
};
};
- /** @description Create a refund.
*/
+ /**
+ * @description When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
+ *
+ * Creating a new refund will refund a charge that has previously been created but not yet refunded.
+ * Funds will be refunded to the credit or debit card that was originally charged.
+ *
+ * You can optionally refund only part of a charge.
+ * You can do so multiple times, until the entire charge has been refunded.
+ *
+ * Once entirely refunded, a charge can’t be refunded again.
+ * This method will raise an error when called on an already-refunded charge,
+ * or when trying to refund more money than is left on a charge.
+ */
PostRefunds: {
requestBody?: {
content: {
"application/x-www-form-urlencoded": {
- /** @description A positive integer representing how much to refund. */
amount?: number;
+ /** @description The identifier of the charge to refund. */
charge?: string;
/** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */
currency?: string;
@@ -36405,10 +36467,16 @@ export interface operations {
* @enum {string}
*/
origin?: "customer_balance";
+ /** @description The identifier of the PaymentIntent to refund. */
payment_intent?: string;
- /** @enum {string} */
+ /**
+ * @description String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms.
+ * @enum {string}
+ */
reason?: "duplicate" | "fraudulent" | "requested_by_customer";
+ /** @description Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge. */
refund_application_fee?: boolean;
+ /** @description Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).
A transfer can be reversed only by the application that created the charge. */
reverse_transfer?: boolean;
};
};
@@ -36533,7 +36601,7 @@ export interface operations {
};
/** @description Returns a list of Report Runs, with the most recent appearing first.
*/
GetReportingReportRuns: {
- parameters?: {
+ parameters: {
query?: {
created?: {
gt?: number;
@@ -36660,7 +36728,7 @@ export interface operations {
};
/** @description Returns a full list of Report Types.
*/
GetReportingReportTypes: {
- parameters?: {
+ parameters: {
query?: {
/** @description Specifies which fields in the response should be expanded. */
expand?: string[];
@@ -36730,7 +36798,7 @@ export interface operations {
};
/** @description Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
*/
GetReviews: {
- parameters?: {
+ parameters: {
query?: {
created?: {
gt?: number;
@@ -36903,7 +36971,7 @@ export interface operations {
};
/** @description Returns a list of SetupIntents.
*/
GetSetupIntents: {
- parameters?: {
+ parameters: {
query?: {
/**
* @description If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
@@ -37958,7 +38026,7 @@ export interface operations {
};
/** @description Returns a list of your shipping rates.
*/
GetShippingRates: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return shipping rates that are active or inactive. */
active?: boolean;
@@ -38175,7 +38243,7 @@ export interface operations {
};
/** @description Returns a list of scheduled query runs.
*/
GetSigmaScheduledQueryRuns: {
- parameters?: {
+ parameters: {
query?: {
/** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */
ending_before?: string;
@@ -39082,7 +39150,7 @@ export interface operations {
};
/** @description Retrieves the list of your subscription schedules.
*/
GetSubscriptionSchedules: {
- parameters?: {
+ parameters: {
query?: {
/** @description Only return subscription schedules that were created canceled the given date interval. */
canceled_at?: {
@@ -39566,7 +39634,7 @@ export interface operations {
};
/** @description By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.
*/
GetSubscriptions: {
- parameters?: {
+ parameters: {
query?: {
/** @description Filter subscriptions by their automatic tax settings. */
automatic_tax?: {
@@ -40470,7 +40538,7 @@ export interface operations {
};
/** @description Retrieves Tax Settings for a merchant.
*/
GetTaxSettings: {
- parameters?: {
+ parameters: {
query?: {
/** @description Specifies which fields in the response should be expanded. */
expand?: string[];
@@ -40719,7 +40787,7 @@ export interface operations {
};
/** @description A list of all tax codes available to add to Products in order to allow specific tax calculations.
*/
GetTaxCodes: {
- parameters?: {
+ parameters: {
query?: {
/** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */
ending_before?: string;
@@ -40795,7 +40863,7 @@ export interface operations {
};
/** @description Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.
*/
GetTaxRates: {
- parameters?: {
+ parameters: {
query?: {
/** @description Optional flag to filter by tax rates that are either active or inactive (archived). */
active?: boolean;
@@ -40983,7 +41051,7 @@ export interface operations {
};
/** @description Returns a list of Configuration objects.
*/
GetTerminalConfigurations: {
- parameters?: {
+ parameters: {
query?: {
/** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */
ending_before?: string;
@@ -41366,7 +41434,7 @@ export interface operations {
};
/** @description Returns a list of Location objects.
*/
GetTerminalLocations: {
- parameters?: {
+ parameters: {
query?: {
/** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */
ending_before?: string;
@@ -41567,7 +41635,7 @@ export interface operations {
};
/** @description Returns a list of Reader objects.
*/
GetTerminalReaders: {
- parameters?: {
+ parameters: {
query?: {
/** @description Filters readers by device type */
device_type?: "bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "simulated_wisepos_e" | "stripe_m2" | "verifone_P400";
@@ -42674,7 +42742,7 @@ export interface operations {
};
/** @description Returns a list of your test clocks.
*/
GetTestHelpersTestClocks: {
- parameters?: {
+ parameters: {
query?: {
/** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */
ending_before?: string;
@@ -43602,7 +43670,7 @@ export interface operations {
};
/** @description Returns a list of top-ups.
*/
GetTopups: {
- parameters?: {
+ parameters: {
query?: {
/** @description A positive integer representing how much to transfer. */
amount?: {
@@ -43801,7 +43869,7 @@ export interface operations {
};
/** @description Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.
*/
GetTransfers: {
- parameters?: {
+ parameters: {
query?: {
created?: {
gt?: number;
@@ -44370,7 +44438,7 @@ export interface operations {
};
/** @description Returns a list of FinancialAccounts.
*/
GetTreasuryFinancialAccounts: {
- parameters?: {
+ parameters: {
query?: {
created?: {
gt?: number;
@@ -45659,7 +45727,7 @@ export interface operations {
};
/** @description Returns a list of your webhook endpoints.
*/
GetWebhookEndpoints: {
- parameters?: {
+ parameters: {
query?: {
/** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */
ending_before?: string;
diff --git a/packages/openapi-typescript/examples/stripe-api.yaml b/packages/openapi-typescript/examples/stripe-api.yaml
index ed33a230c..f9de76017 100644
--- a/packages/openapi-typescript/examples/stripe-api.yaml
+++ b/packages/openapi-typescript/examples/stripe-api.yaml
@@ -26635,7 +26635,7 @@ components:
Stripe account](/docs/connect/bank-debit-card-payouts). You can retrieve
individual payouts,
- as well as list all payouts. Payouts are made on [varying
+ and list all payouts. Payouts are made on [varying
schedules](/docs/connect/manage-payout-schedule), depending on your
country and
@@ -26647,20 +26647,20 @@ components:
properties:
amount:
description: >-
- Amount (in cents (or local equivalent)) to be transferred to your
+ The amount (in cents (or local equivalent)) that transfers to your
bank account or debit card.
type: integer
arrival_date:
description: >-
- Date the payout is expected to arrive in the bank. This factors in
- delays like weekends or bank holidays.
+ Date that you can expect the payout to arrive in the bank. This
+ factors in delays to account for weekends or bank holidays.
format: unix-time
type: integer
automatic:
description: >-
- Returns `true` if the payout was created by an [automated payout
- schedule](https://stripe.com/docs/payouts#payout-schedule), and
- `false` if it was [requested
+ Returns `true` if the payout is created by an [automated payout
+ schedule](https://stripe.com/docs/payouts#payout-schedule) and
+ `false` if it's [requested
manually](https://stripe.com/docs/payouts#manual-payouts).
type: boolean
balance_transaction:
@@ -26703,7 +26703,7 @@ components:
- $ref: '#/components/schemas/card'
- $ref: '#/components/schemas/deleted_bank_account'
- $ref: '#/components/schemas/deleted_card'
- description: ID of the bank account or card the payout was sent to.
+ description: ID of the bank account or card the payout is sent to.
nullable: true
x-expansionResources:
oneOf:
@@ -26718,26 +26718,23 @@ components:
type: string
- $ref: '#/components/schemas/balance_transaction'
description: >-
- If the payout failed or was canceled, this will be the ID of the
- balance transaction that reversed the initial balance transaction,
- and puts the funds from the failed payout back in your balance.
+ If the payout fails or cancels, this is the ID of the balance
+ transaction that reverses the initial balance transaction and
+ returns the funds from the failed payout back in your balance.
nullable: true
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/balance_transaction'
failure_code:
description: >-
- Error code explaining reason for payout failure if available. See
- [Types of payout
- failures](https://stripe.com/docs/api#payout_failures) for a list of
- failure codes.
+ Error code that provides a reason for a payout failure, if
+ available. View our [list of failure
+ codes](https://stripe.com/docs/api#payout_failures).
maxLength: 5000
nullable: true
type: string
failure_message:
- description: >-
- Message to user further explaining reason for payout failure if
- available.
+ description: 'Message that provides the reason for a payout failure, if available.'
maxLength: 5000
nullable: true
type: string
@@ -26764,9 +26761,9 @@ components:
description: >-
The method used to send this payout, which can be `standard` or
`instant`. `instant` is supported for payouts to debit cards and
- bank accounts in certain countries. (See [Bank support for Instant
- Payouts](https://stripe.com/docs/payouts/instant-payouts-banks) for
- more information.)
+ bank accounts in certain countries. Learn more about [bank support
+ for Instant
+ Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).
maxLength: 5000
type: string
object:
@@ -26790,10 +26787,9 @@ components:
- $ref: '#/components/schemas/payout'
reconciliation_status:
description: >-
- If `completed`, the [Balance Transactions
+ If `completed`, you can use the [Balance Transactions
API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout)
- may be used to list all Balance Transactions that were paid out in
- this payout.
+ to list all balance transactions that are paid out in this payout.
enum:
- completed
- in_progress
@@ -26805,21 +26801,21 @@ components:
type: string
- $ref: '#/components/schemas/payout'
description: >-
- If the payout was reversed, this is the ID of the payout that
- reverses this payout.
+ If the payout reverses, this is the ID of the payout that reverses
+ this payout.
nullable: true
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/payout'
source_type:
description: >-
- The source balance this payout came from. One of `card`, `fpx`, or
- `bank_account`.
+ The source balance this payout came from, which can be one of the
+ following: `card`, `fpx`, or `bank_account`.
maxLength: 5000
type: string
statement_descriptor:
description: >-
- Extra information about a payout to be displayed on the user's bank
+ Extra information about a payout that displays on the user's bank
statement.
maxLength: 5000
nullable: true
@@ -26827,11 +26823,11 @@ components:
status:
description: >-
Current status of the payout: `paid`, `pending`, `in_transit`,
- `canceled` or `failed`. A payout is `pending` until it is submitted
- to the bank, when it becomes `in_transit`. The status then changes
- to `paid` if the transaction goes through, or to `failed` or
- `canceled` (within 5 business days). Some failed payouts may
- initially show as `paid` but then change to `failed`.
+ `canceled` or `failed`. A payout is `pending` until it's submitted
+ to the bank, when it becomes `in_transit`. The status changes to
+ `paid` if the transaction succeeds, or to `failed` or `canceled`
+ (within 5 business days). Some payouts that fail might initially
+ show as `paid`, then change to `failed`.
maxLength: 5000
type: string
type:
@@ -49947,7 +49943,8 @@ paths:
or when trying to refund more money than is left on a charge.
operationId: PostChargesChargeRefund
parameters:
- - in: path
+ - description: The identifier of the charge to refund.
+ in: path
name: charge
required: true
schema:
@@ -49968,6 +49965,10 @@ paths:
additionalProperties: false
properties:
amount:
+ description: >-
+ A positive integer in cents (or local equivalent)
+ representing how much of this charge to refund. Can refund
+ only up to the remaining, unrefunded amount of the charge.
type: integer
expand:
description: Specifies which fields in the response should be expanded.
@@ -49998,9 +49999,18 @@ paths:
value to them. All keys can be unset by posting an empty
value to `metadata`.
payment_intent:
+ description: The identifier of the PaymentIntent to refund.
maxLength: 5000
type: string
reason:
+ description: >-
+ String indicating the reason for the refund. If set,
+ possible values are `duplicate`, `fraudulent`, and
+ `requested_by_customer`. If you believe the charge to be
+ fraudulent, specifying `fraudulent` as the reason will add
+ the associated card and email to your [block
+ lists](https://stripe.com/docs/radar/lists), and will also
+ help us improve our fraud detection algorithms.
enum:
- duplicate
- fraudulent
@@ -50008,8 +50018,22 @@ paths:
maxLength: 5000
type: string
refund_application_fee:
+ description: >-
+ Boolean indicating whether the application fee should be
+ refunded when refunding this charge. If a full charge refund
+ is given, the full application fee will be refunded.
+ Otherwise, the application fee will be refunded in an amount
+ proportional to the amount of the charge refunded. An
+ application fee can be refunded only by the application that
+ created the charge.
type: boolean
reverse_transfer:
+ description: >-
+ Boolean indicating whether the transfer should be reversed
+ when refunding this charge. The transfer will be reversed
+ proportionally to the amount being refunded (either the
+ entire or partial amount).
A transfer can be reversed
+ only by the application that created the charge.
type: boolean
type: object
required: false
@@ -50140,10 +50164,34 @@ paths:
$ref: '#/components/schemas/error'
description: Error response.
post:
- description: Create a refund.
+ description: >-
+ When you create a new refund, you must specify a Charge or a
+ PaymentIntent object on which to create it.
+
+
+ Creating a new refund will refund a charge that has previously been
+ created but not yet refunded.
+
+ Funds will be refunded to the credit or debit card that was originally
+ charged.
+
+
+ You can optionally refund only part of a charge.
+
+ You can do so multiple times, until the entire charge has been
+ refunded.
+
+
+ Once entirely refunded, a charge can’t be refunded again.
+
+ This method will raise an error when called on an already-refunded
+ charge,
+
+ or when trying to refund more money than is left on a charge.
operationId: PostChargesChargeRefunds
parameters:
- - in: path
+ - description: The identifier of the charge to refund.
+ in: path
name: charge
required: true
schema:
@@ -50164,7 +50212,6 @@ paths:
additionalProperties: false
properties:
amount:
- description: A positive integer representing how much to refund.
type: integer
currency:
description: >-
@@ -50211,9 +50258,18 @@ paths:
- customer_balance
type: string
payment_intent:
+ description: The identifier of the PaymentIntent to refund.
maxLength: 5000
type: string
reason:
+ description: >-
+ String indicating the reason for the refund. If set,
+ possible values are `duplicate`, `fraudulent`, and
+ `requested_by_customer`. If you believe the charge to be
+ fraudulent, specifying `fraudulent` as the reason will add
+ the associated card and email to your [block
+ lists](https://stripe.com/docs/radar/lists), and will also
+ help us improve our fraud detection algorithms.
enum:
- duplicate
- fraudulent
@@ -50221,8 +50277,22 @@ paths:
maxLength: 5000
type: string
refund_application_fee:
+ description: >-
+ Boolean indicating whether the application fee should be
+ refunded when refunding this charge. If a full charge refund
+ is given, the full application fee will be refunded.
+ Otherwise, the application fee will be refunded in an amount
+ proportional to the amount of the charge refunded. An
+ application fee can be refunded only by the application that
+ created the charge.
type: boolean
reverse_transfer:
+ description: >-
+ Boolean indicating whether the transfer should be reversed
+ when refunding this charge. The transfer will be reversed
+ proportionally to the amount being refunded (either the
+ entire or partial amount).
A transfer can be reversed
+ only by the application that created the charge.
type: boolean
type: object
required: false
@@ -86049,7 +86119,7 @@ paths:
get:
description: >-
Returns a list of existing payouts sent to third-party bank accounts
- or that Stripe has sent you. The payouts are returned in sorted order,
+ or payouts that Stripe sent to you. The payouts return in sorted order,
with the most recently created payouts appearing first.
operationId: GetPayouts
parameters:
@@ -86211,20 +86281,19 @@ paths:
description: Error response.
post:
description: >-
- To send funds to your own bank account, you create a new payout
- object. Your Stripe balance must be able to cover
- the payout amount, or you’ll receive an “Insufficient Funds” error.
+ To send funds to your own bank account, create a new payout object.
+ Your Stripe balance must cover the payout amount.
+ If it doesn’t, you receive an “Insufficient Funds” error.
If your API key is in test mode, money won’t actually be sent, though
- everything else will occur as if in live mode.
+ every other action occurs as if you’re in live mode.
- If you are creating a manual payout on a Stripe account that uses
- multiple payment source types, you’ll need to specify the source type
- balance that the payout should draw from. The balance object details available and pending
- amounts by source type.
+ If you create a manual payout on a Stripe account that uses multiple
+ payment source types, you need to specify the source type balance that
+ the payout draws from. The balance object
+ details available and pending amounts by source type.
operationId: PostPayouts
requestBody:
content:
@@ -86258,8 +86327,8 @@ paths:
destination:
description: >-
The ID of a bank account or a card to send the payout to. If
- no destination is supplied, the default external account for
- the specified currency will be used.
+ you don't provide a destination, we use the default external
+ account for the specified currency.
type: string
expand:
description: Specifies which fields in the response should be expanded.
@@ -86281,12 +86350,11 @@ paths:
type: object
method:
description: >-
- The method used to send this payout, which can be `standard`
- or `instant`. `instant` is supported for payouts to debit
- cards and bank accounts in certain countries. (See [Bank
- support for Instant
- Payouts](https://stripe.com/docs/payouts/instant-payouts-banks)
- for more information.)
+ The method used to send this payout, which is `standard` or
+ `instant`. We support `instant` for payouts to debit cards
+ and bank accounts in certain countries. Learn more about
+ [bank support for Instant
+ Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).
enum:
- instant
- standard
@@ -86297,7 +86365,7 @@ paths:
description: >-
The balance type of your Stripe balance to draw this payout
from. Balances for different payment sources are kept
- separately. You can find the amounts with the balances API.
+ separately. You can find the amounts with the Balances API.
One of `bank_account`, `card`, or `fpx`.
enum:
- bank_account
@@ -86308,12 +86376,11 @@ paths:
x-stripeBypassValidation: true
statement_descriptor:
description: >-
- A string to be displayed on the recipient's bank or card
- statement. This may be at most 22 characters. Attempting to
- use a `statement_descriptor` longer than 22 characters will
- return an error. Note: Most banks will truncate this
- information and/or display it inconsistently. Some may not
- display it at all.
+ A string that displays on the recipient's bank or card
+ statement (up to 22 characters). A `statement_descriptor`
+ that's longer than 22 characters return an error. Most banks
+ truncate this information and display it inconsistently.
+ Some banks might not display it at all.
maxLength: 22
type: string
x-stripeBypassValidation: true
@@ -86339,8 +86406,8 @@ paths:
get:
description: >-
Retrieves the details of an existing payout. Supply the unique payout
- ID from either a payout creation request or the payout list, and Stripe
- will return the corresponding payout information.
+ ID from either a payout creation request or the payout list. Stripe
+ returns the corresponding payout information.
operationId: GetPayoutsPayout
parameters:
- description: Specifies which fields in the response should be expanded.
@@ -86386,8 +86453,8 @@ paths:
post:
description: >-
Updates the specified payout by setting the values of the parameters
- passed. Any parameters not provided will be left unchanged. This request
- accepts only the metadata as arguments.
+ you pass. We don’t change parameters that you don’t provide. This
+ request only accepts the metadata as arguments.
operationId: PostPayoutsPayout
parameters:
- in: path
@@ -86450,8 +86517,8 @@ paths:
'/v1/payouts/{payout}/cancel':
post:
description: >-
- A previously created payout can be canceled if it has not yet been
- paid out. Funds will be refunded to your available balance. You may not
+
You can cancel a previously created payout if it hasn’t been paid out
+ yet. Stripe refunds the funds to your available balance. You can’t
cancel automatic Stripe payouts.
operationId: PostPayoutsPayoutCancel
parameters:
@@ -86496,16 +86563,16 @@ paths:
'/v1/payouts/{payout}/reverse':
post:
description: >-
- Reverses a payout by debiting the destination bank account. Only
- payouts for connected accounts to US bank accounts may be reversed at
- this time. If the payout is in the pending status,
- /v1/payouts/:id/cancel should be used instead.
+ Reverses a payout by debiting the destination bank account. At this
+ time, you can only reverse payouts for connected accounts to US bank
+ accounts. If the payout is in the pending status, use
+ /v1/payouts/:id/cancel instead.
- By requesting a reversal via /v1/payouts/:id/reverse,
- you confirm that the authorized signatory of the selected bank account
- has authorized the debit on the bank account and that no other
- authorization is required.
+ By requesting a reversal through
+ /v1/payouts/:id/reverse, you confirm that the authorized
+ signatory of the selected bank account authorizes the debit on the bank
+ account and that no other authorization is required.
operationId: PostPayoutsPayoutReverse
parameters:
- in: path
@@ -91514,7 +91581,30 @@ paths:
$ref: '#/components/schemas/error'
description: Error response.
post:
- description: Create a refund.
+ description: >-
+ When you create a new refund, you must specify a Charge or a
+ PaymentIntent object on which to create it.
+
+
+ Creating a new refund will refund a charge that has previously been
+ created but not yet refunded.
+
+ Funds will be refunded to the credit or debit card that was originally
+ charged.
+
+
+ You can optionally refund only part of a charge.
+
+ You can do so multiple times, until the entire charge has been
+ refunded.
+
+
+ Once entirely refunded, a charge can’t be refunded again.
+
+ This method will raise an error when called on an already-refunded
+ charge,
+
+ or when trying to refund more money than is left on a charge.
operationId: PostRefunds
requestBody:
content:
@@ -91530,9 +91620,9 @@ paths:
additionalProperties: false
properties:
amount:
- description: A positive integer representing how much to refund.
type: integer
charge:
+ description: The identifier of the charge to refund.
maxLength: 5000
type: string
currency:
@@ -91580,9 +91670,18 @@ paths:
- customer_balance
type: string
payment_intent:
+ description: The identifier of the PaymentIntent to refund.
maxLength: 5000
type: string
reason:
+ description: >-
+ String indicating the reason for the refund. If set,
+ possible values are `duplicate`, `fraudulent`, and
+ `requested_by_customer`. If you believe the charge to be
+ fraudulent, specifying `fraudulent` as the reason will add
+ the associated card and email to your [block
+ lists](https://stripe.com/docs/radar/lists), and will also
+ help us improve our fraud detection algorithms.
enum:
- duplicate
- fraudulent
@@ -91590,8 +91689,22 @@ paths:
maxLength: 5000
type: string
refund_application_fee:
+ description: >-
+ Boolean indicating whether the application fee should be
+ refunded when refunding this charge. If a full charge refund
+ is given, the full application fee will be refunded.
+ Otherwise, the application fee will be refunded in an amount
+ proportional to the amount of the charge refunded. An
+ application fee can be refunded only by the application that
+ created the charge.
type: boolean
reverse_transfer:
+ description: >-
+ Boolean indicating whether the transfer should be reversed
+ when refunding this charge. The transfer will be reversed
+ proportionally to the amount being refunded (either the
+ entire or partial amount).
A transfer can be reversed
+ only by the application that created the charge.
type: boolean
type: object
required: false
diff --git a/packages/openapi-typescript/src/transform/operation-object.ts b/packages/openapi-typescript/src/transform/operation-object.ts
index 0671772f4..2d7b98092 100644
--- a/packages/openapi-typescript/src/transform/operation-object.ts
+++ b/packages/openapi-typescript/src/transform/operation-object.ts
@@ -15,7 +15,6 @@ export default function transformOperationObject(operationObject: OperationObjec
let { indentLv } = ctx;
const output: string[] = wrapObject ? ["{"] : [];
indentLv++;
- let allParamsOptional = true;
// parameters
{
@@ -32,7 +31,6 @@ export default function transformOperationObject(operationObject: OperationObjec
let key = escObjKey(node.name);
const isRequired = paramIn === "path" || !!node.required;
if (isRequired) {
- allParamsOptional = false;
paramInOptional = false;
} else {
key = tsOptionalProperty(key);
@@ -59,8 +57,7 @@ export default function transformOperationObject(operationObject: OperationObjec
indentLv--;
if (parameterOutput.length) {
- const parameterKey = allParamsOptional ? tsOptionalProperty("parameters") : "parameters";
- output.push(indent(`${parameterKey}: {`, indentLv));
+ output.push(indent(`parameters: {`, indentLv));
output.push(parameterOutput.join("\n"));
output.push(indent("};", indentLv));
}
diff --git a/packages/openapi-typescript/test/index.test.ts b/packages/openapi-typescript/test/index.test.ts
index 4d97a243a..dc1254a14 100644
--- a/packages/openapi-typescript/test/index.test.ts
+++ b/packages/openapi-typescript/test/index.test.ts
@@ -238,7 +238,7 @@ export type operations = Record;
export interface paths {
"/post/{id}": {
get: operations["getPost"];
- parameters?: {
+ parameters: {
query?: {
revision?: number;
};
diff --git a/packages/openapi-typescript/test/operation-object.test.ts b/packages/openapi-typescript/test/operation-object.test.ts
index 87a96c6bd..905779d7c 100644
--- a/packages/openapi-typescript/test/operation-object.test.ts
+++ b/packages/openapi-typescript/test/operation-object.test.ts
@@ -100,7 +100,7 @@ describe("Operation Object", () => {
};
const generated = transformOperationObject(schema, options);
expect(generated).toBe(`{
- parameters?: {
+ parameters: {
query?: {
search?: string;
};
diff --git a/packages/openapi-typescript/test/paths-object.test.ts b/packages/openapi-typescript/test/paths-object.test.ts
index 7d5c2b64a..8a79598b9 100644
--- a/packages/openapi-typescript/test/paths-object.test.ts
+++ b/packages/openapi-typescript/test/paths-object.test.ts
@@ -86,7 +86,7 @@ describe("Paths Object", () => {
404: components["responses"]["NotFound"];
};
};
- parameters?: {
+ parameters: {
query?: {
/** @description Page number. */
page?: number;
@@ -187,7 +187,7 @@ describe("Paths Object", () => {
expect(generated).toBe(`{
"/api/v1/user/me": {
get: {
- parameters?: {
+ parameters: {
query?: {
/** @description Page number. */
page?: number;
@@ -210,7 +210,7 @@ describe("Paths Object", () => {
404: components["responses"]["NotFound"];
};
};
- parameters?: {
+ parameters: {
query?: {
/** @description Page number. */
page?: number;