diff --git a/.changeset/silly-maps-rush.md b/.changeset/silly-maps-rush.md new file mode 100644 index 000000000..c58d34b02 --- /dev/null +++ b/.changeset/silly-maps-rush.md @@ -0,0 +1,5 @@ +--- +"openapi-typescript": patch +--- + +Fix bugs with remote $refs, add `cwd` option for JSON schema parsing diff --git a/docs/src/content/docs/node.md b/docs/src/content/docs/node.md index bb1aa73a7..4bca17366 100644 --- a/docs/src/content/docs/node.md +++ b/docs/src/content/docs/node.md @@ -43,12 +43,13 @@ const output = await openapiTS("https://myurl.com/v1/openapi.yaml"); The Node API supports all the [CLI flags](/cli#options) in `camelCase` format, plus the following additional options: -| Name | Type | Default | Description | -| :-------------- | :--------: | :------ | :------------------------------------------------------------------------------- | -| `commentHeader` | `string` | | Override the default “This file was auto-generated …” file heading | -| `inject` | `string` | | Inject arbitrary TypeScript types into the start of the file | -| `transform` | `Function` | | Override the default Schema Object ➝ TypeScript transformer in certain scenarios | -| `postTransform` | `Function` | | Same as `transform` but runs _after_ the TypeScript transformation | +| Name | Type | Default | Description | +| :-------------- | :-------------: | :------ | :------------------------------------------------------------------------------------------------------------------- | +| `commentHeader` | `string` | | Override the default “This file was auto-generated …” file heading | +| `inject` | `string` | | Inject arbitrary TypeScript types into the start of the file | +| `transform` | `Function` | | Override the default Schema Object ➝ TypeScript transformer in certain scenarios | +| `postTransform` | `Function` | | Same as `transform` but runs _after_ the TypeScript transformation | +| `cwd` | `string \| URL` | | (optional) Provide the current working directory to resolve remote `$ref`s (only needed for in-memory JSON objects). | ### transform / postTransform diff --git a/packages/openapi-typescript/examples/digital-ocean-api.ts b/packages/openapi-typescript/examples/digital-ocean-api.ts index 938b22eda..7f06ddcb8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api.ts +++ b/packages/openapi-typescript/examples/digital-ocean-api.ts @@ -705,7 +705,7 @@ export interface external { * @example 50a994b6-c303-438f-9495-7e896cfe6b08 */ cluster_uuid: string; - } + }; "resources/1-clicks/models/oneClicks.yml": { /** * slug @@ -719,7 +719,7 @@ export interface external { * @example kubernetes */ type: string; - } + }; /** * Install Kubernetes 1-Click Applications * @description To install a Kubernetes 1-Click application on a cluster, send a POST request to @@ -865,7 +865,7 @@ export interface external { */ name?: string; }; - } + }; "resources/account/responses/account.yml": { headers: { "ratelimit-limit": external["shared/headers.yml"]["ratelimit-limit"]; @@ -958,7 +958,7 @@ export interface external { resource_type?: string; region?: external["resources/regions/models/region.yml"]; region_slug?: external["resources/regions/models/region.yml"]["slug"] & (string | null); - } + }; "resources/actions/parameters.yml": { action_id: number; }; @@ -1626,8 +1626,8 @@ export interface external { default: external["shared/responses/unexpected_error.yml"]; }; } - "resources/apps/models/app_alert_email.yml": string - "resources/apps/models/app_alert_phase.yml": "UNKNOWN" | "PENDING" | "CONFIGURING" | "ACTIVE" | "ERROR" + "resources/apps/models/app_alert_email.yml": string; + "resources/apps/models/app_alert_phase.yml": "UNKNOWN" | "PENDING" | "CONFIGURING" | "ACTIVE" | "ERROR"; "resources/apps/models/app_alert_progress_step_reason.yml": { /** * The error code @@ -1639,8 +1639,8 @@ export interface external { * @example This is an error */ message?: string; - } - "resources/apps/models/app_alert_progress_step_status.yml": "UNKNOWN" | "PENDING" | "RUNNING" | "ERROR" | "SUCCESS" + }; + "resources/apps/models/app_alert_progress_step_status.yml": "UNKNOWN" | "PENDING" | "RUNNING" | "ERROR" | "SUCCESS"; "resources/apps/models/app_alert_progress_step.yml": { /** * The name of this step @@ -1661,11 +1661,11 @@ export interface external { */ ended_at?: string; reason?: external["resources/apps/models/app_alert_progress_step_reason.yml"]; - } + }; "resources/apps/models/app_alert_progress.yml": { /** Steps of an alert's progress. */ steps?: external["resources/apps/models/app_alert_progress_step.yml"][]; - } + }; "resources/apps/models/app_alert_slack_webhook.yml": { /** * URL of the Slack webhook @@ -1677,10 +1677,10 @@ export interface external { * @example Channel Name */ channel?: string; - } - "resources/apps/models/app_alert_spec_operator.yml": "UNSPECIFIED_OPERATOR" | "GREATER_THAN" | "LESS_THAN" - "resources/apps/models/app_alert_spec_rule.yml": "UNSPECIFIED_RULE" | "CPU_UTILIZATION" | "MEM_UTILIZATION" | "RESTART_COUNT" | "DEPLOYMENT_FAILED" | "DEPLOYMENT_LIVE" | "DOMAIN_FAILED" | "DOMAIN_LIVE" | "FUNCTIONS_ACTIVATION_COUNT" | "FUNCTIONS_AVERAGE_DURATION_MS" | "FUNCTIONS_ERROR_RATE_PER_MINUTE" | "FUNCTIONS_AVERAGE_WAIT_TIME_MS" | "FUNCTIONS_ERROR_COUNT" | "FUNCTIONS_GB_RATE_PER_SECOND" - "resources/apps/models/app_alert_spec_window.yml": "UNSPECIFIED_WINDOW" | "FIVE_MINUTES" | "TEN_MINUTES" | "THIRTY_MINUTES" | "ONE_HOUR" + }; + "resources/apps/models/app_alert_spec_operator.yml": "UNSPECIFIED_OPERATOR" | "GREATER_THAN" | "LESS_THAN"; + "resources/apps/models/app_alert_spec_rule.yml": "UNSPECIFIED_RULE" | "CPU_UTILIZATION" | "MEM_UTILIZATION" | "RESTART_COUNT" | "DEPLOYMENT_FAILED" | "DEPLOYMENT_LIVE" | "DOMAIN_FAILED" | "DOMAIN_LIVE" | "FUNCTIONS_ACTIVATION_COUNT" | "FUNCTIONS_AVERAGE_DURATION_MS" | "FUNCTIONS_ERROR_RATE_PER_MINUTE" | "FUNCTIONS_AVERAGE_WAIT_TIME_MS" | "FUNCTIONS_ERROR_COUNT" | "FUNCTIONS_GB_RATE_PER_SECOND"; + "resources/apps/models/app_alert_spec_window.yml": "UNSPECIFIED_WINDOW" | "FIVE_MINUTES" | "TEN_MINUTES" | "THIRTY_MINUTES" | "ONE_HOUR"; "resources/apps/models/app_alert_spec.yml": { rule?: external["resources/apps/models/app_alert_spec_rule.yml"]; /** @@ -1696,7 +1696,7 @@ export interface external { */ value?: number; window?: external["resources/apps/models/app_alert_spec_window.yml"]; - } + }; "resources/apps/models/app_alert.yml": { /** * The ID of the alert @@ -1720,7 +1720,7 @@ export interface external { slack_webhooks?: external["resources/apps/models/app_alert_slack_webhook.yml"][]; phase?: external["resources/apps/models/app_alert_phase.yml"]; progress?: external["resources/apps/models/app_alert_progress.yml"]; - } + }; "resources/apps/models/app_component_base.yml": { /** * @description The name. Must be unique across all components within the same app. @@ -1759,7 +1759,7 @@ export interface external { */ environment_slug?: string; log_destinations?: external["resources/apps/models/app_log_destination_definition.yml"]; - } + }; "resources/apps/models/app_component_instance_base.yml": { /** * Format: int64 @@ -1775,7 +1775,7 @@ export interface external { * @enum {string} */ instance_size_slug?: "basic-xxs" | "basic-xs" | "basic-s" | "basic-m" | "professional-xs" | "professional-s" | "professional-m" | "professional-1l" | "professional-l" | "professional-xl"; - } + }; "resources/apps/models/app_database_spec.yml": { /** * @description The name of the underlying DigitalOcean DBaaS cluster. This is required for production databases. For dev databases, if cluster_name is not set, a new cluster will be provisioned. @@ -1816,7 +1816,7 @@ export interface external { * @example 12 */ version?: string; - } + }; "resources/apps/models/app_domain_spec.yml": { /** * @description The hostname for the domain @@ -1854,7 +1854,7 @@ export interface external { * @enum {string} */ minimum_tls_version?: "1.2" | "1.3"; - } + }; "resources/apps/models/app_domain_validation.yml": { /** * TXT record name @@ -1866,7 +1866,7 @@ export interface external { * @example lXLOcN6cPv0nproViNcUHcahD9TrIPlNgdwesj0pYpk */ txt_value?: string; - } + }; "resources/apps/models/app_functions_spec.yml": { cors?: external["resources/apps/models/apps_cors_policy.yml"]; /** @description A list of HTTP routes that should be routed to this component. */ @@ -1888,10 +1888,10 @@ export interface external { github?: external["resources/apps/models/apps_github_source_spec.yml"]; gitlab?: external["resources/apps/models/apps_gitlab_source_spec.yml"]; log_destinations?: external["resources/apps/models/app_log_destination_definition.yml"]; - } + }; "resources/apps/models/app_ingress_spec_rule_match.yml": { path: external["resources/apps/models/app_ingress_spec_rule_string_match.yml"]; - } + }; "resources/apps/models/app_ingress_spec_rule_routing_component.yml": { /** * @description The name of the component to route to. @@ -1908,7 +1908,7 @@ export interface external { * @example /api/v1/ */ rewrite?: string; - } + }; "resources/apps/models/app_ingress_spec_rule_routing_redirect.yml": { /** * @description An optional URI path to redirect to. Note: if this is specified the whole URI of the original request will be overwritten to this value, irrespective of the original request URI being matched. @@ -1937,24 +1937,24 @@ export interface external { * @example 302 */ redirect_code?: number; - } + }; "resources/apps/models/app_ingress_spec_rule_string_match.yml": { /** * @description Prefix-based match. For example, `/api` will match `/api`, `/api/`, and any nested paths such as `/api/v1/endpoint`. * @example /api */ prefix: string; - } + }; "resources/apps/models/app_ingress_spec_rule.yml": { match?: external["resources/apps/models/app_ingress_spec_rule_match.yml"]; cors?: external["resources/apps/models/apps_cors_policy.yml"]; component?: external["resources/apps/models/app_ingress_spec_rule_routing_component.yml"]; redirect?: external["resources/apps/models/app_ingress_spec_rule_routing_redirect.yml"]; - } + }; "resources/apps/models/app_ingress_spec.yml": { /** @description Rules for configuring HTTP ingress for component routes, CORS, rewrites, and redirects. */ rules?: external["resources/apps/models/app_ingress_spec_rule.yml"][]; - } + }; "resources/apps/models/app_job_spec.yml": external["resources/apps/models/app_component_base.yml"] & external["resources/apps/models/app_component_instance_base.yml"] & ({ /** * @description - UNSPECIFIED: Default job type, will auto-complete to POST_DEPLOY kind. @@ -1966,7 +1966,7 @@ export interface external { * @enum {string} */ kind?: "UNSPECIFIED" | "PRE_DEPLOY" | "POST_DEPLOY" | "FAILED_DEPLOY"; - }) + }); "resources/apps/models/app_log_destination_datadog_spec.yml": { /** * @description Datadog HTTP log intake endpoint. @@ -1978,28 +1978,28 @@ export interface external { * @example abcdefghijklmnopqrstuvwxyz0123456789 */ api_key: string; - } + }; "resources/apps/models/app_log_destination_definition.yml": { /** @example my_log_destination */ name: string; papertrail?: external["resources/apps/models/app_log_destination_papertrail_spec.yml"]; datadog?: external["resources/apps/models/app_log_destination_datadog_spec.yml"]; logtail?: external["resources/apps/models/app_log_destination_logtail_spec.yml"]; - } + }; "resources/apps/models/app_log_destination_logtail_spec.yml": { /** * @description Logtail token. * @example abcdefghijklmnopqrstuvwxyz0123456789 */ token?: string; - } + }; "resources/apps/models/app_log_destination_papertrail_spec.yml": { /** * @description Papertrail syslog endpoint. * @example https://mypapertrailendpoint.com */ endpoint: string; - } + }; "resources/apps/models/app_metrics_bandwidth_usage_details.yml": { /** * @description The ID of the app. @@ -2012,7 +2012,7 @@ export interface external { * @example 513668 */ bandwidth_bytes?: string; - } + }; "resources/apps/models/app_metrics_bandwidth_usage_request.yml": { /** * @description A list of app IDs to query bandwidth metrics for. @@ -2028,7 +2028,7 @@ export interface external { * @example "2023-01-17T00:00:00.000Z" */ date?: string; - } + }; "resources/apps/models/app_metrics_bandwidth_usage.yml": { /** @description A list of bandwidth usage details by app. */ app_bandwidth_usage?: external["resources/apps/models/app_metrics_bandwidth_usage_details.yml"][]; @@ -2038,7 +2038,7 @@ export interface external { * @example "2023-01-17T00:00:00.000Z" */ date?: string; - } + }; "resources/apps/models/app_propose_response.yml": { /** * @description Indicates whether the app is a static app. @@ -2073,7 +2073,7 @@ export interface external { * @example 17 */ app_tier_downgrade_cost?: number; - } + }; "resources/apps/models/app_propose.yml": { spec: external["resources/apps/models/app_spec.yml"]; /** @@ -2081,10 +2081,10 @@ export interface external { * @example b6bdf840-2854-4f87-a36c-5f231c617c84 */ app_id?: string; - } + }; "resources/apps/models/app_response.yml": { app?: external["resources/apps/models/app.yml"]; - } + }; "resources/apps/models/app_rollback_validation_condition.yml": { /** * @description A code identifier that represents the failing condition. @@ -2116,7 +2116,7 @@ export interface external { * ] */ components?: string[]; - } + }; "resources/apps/models/app_route_spec.yml": { /** * @description An HTTP path prefix. Paths must start with / and must be unique across all components within an app. @@ -2128,7 +2128,7 @@ export interface external { * @example true */ preserve_path_prefix?: boolean; - } + }; "resources/apps/models/app_service_spec_health_check.yml": { /** * Format: int32 @@ -2171,7 +2171,7 @@ export interface external { * @example 45 */ timeout_seconds?: number; - } + }; "resources/apps/models/app_service_spec.yml": external["resources/apps/models/app_component_base.yml"] & external["resources/apps/models/app_component_instance_base.yml"] & { cors?: external["resources/apps/models/apps_cors_policy.yml"]; health_check?: external["resources/apps/models/app_service_spec_health_check.yml"]; @@ -2192,7 +2192,7 @@ export interface external { internal_ports?: number[]; /** @description A list of HTTP routes that should be routed to this component. */ routes?: external["resources/apps/models/app_route_spec.yml"][]; - } + }; "resources/apps/models/app_spec.yml": { /** * @description The name of the app. Must be unique across all apps in the same account. @@ -2223,7 +2223,7 @@ export interface external { */ databases?: external["resources/apps/models/app_database_spec.yml"][]; ingress?: external["resources/apps/models/app_ingress_spec.yml"]; - } + }; "resources/apps/models/app_static_site_spec.yml": WithRequired + }, "name">; "resources/apps/models/app_variable_definition.yml": { /** * @description The variable name @@ -2279,8 +2279,8 @@ export interface external { * @example http://example.com */ value?: string; - } - "resources/apps/models/app_worker_spec.yml": WithRequired + }; + "resources/apps/models/app_worker_spec.yml": WithRequired; "resources/apps/models/app.yml": { active_deployment?: external["resources/apps/models/apps_deployment.yml"]; /** @@ -2348,10 +2348,10 @@ export interface external { */ updated_at?: string; pinned_deployment?: external["resources/apps/models/apps_deployment.yml"]; - } + }; "resources/apps/models/apps_alert_response.yml": { alert?: external["resources/apps/models/app_alert.yml"]; - } + }; "resources/apps/models/apps_assign_app_alert_destinations_request.yml": { /** * @example [ @@ -2360,7 +2360,7 @@ export interface external { */ emails?: external["resources/apps/models/app_alert_email.yml"][]; slack_webhooks?: external["resources/apps/models/app_alert_slack_webhook.yml"][]; - } + }; "resources/apps/models/apps_cors_policy.yml": { /** * @description The set of allowed CORS origins. @@ -2412,26 +2412,26 @@ export interface external { * @example false */ allow_credentials?: boolean; - } + }; "resources/apps/models/apps_create_app_request.yml": { spec: external["resources/apps/models/app_spec.yml"]; /** @description The ID of the project the app should be assigned to. If omitted, it will be assigned to your default project. */ project_id?: string; - } + }; "resources/apps/models/apps_create_deployment_request.yml": { /** * Indicates whether to force a build of app from source even if an existing cached build is suitable for re-use * @example true */ force_build?: boolean; - } + }; "resources/apps/models/apps_delete_app_response.yml": { /** * The ID of the app that was deleted * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ id?: string; - } + }; "resources/apps/models/apps_deployment_functions.yml": { /** * The name of this functions component @@ -2448,7 +2448,7 @@ export interface external { * @example ap-b2a93513-8d9b-4223-9d61-5e7272c81c32 */ namespace?: string; - } + }; "resources/apps/models/apps_deployment_job.yml": { /** * The name of this job @@ -2460,8 +2460,8 @@ export interface external { * @example 54d4a727f457231062439895000d45437c7bb405 */ source_commit_hash?: string; - } - "resources/apps/models/apps_deployment_phase.yml": "UNKNOWN" | "PENDING_BUILD" | "BUILDING" | "PENDING_DEPLOY" | "DEPLOYING" | "ACTIVE" | "SUPERSEDED" | "ERROR" | "CANCELED" + }; + "resources/apps/models/apps_deployment_phase.yml": "UNKNOWN" | "PENDING_BUILD" | "BUILDING" | "PENDING_DEPLOY" | "DEPLOYING" | "ACTIVE" | "SUPERSEDED" | "ERROR" | "CANCELED"; "resources/apps/models/apps_deployment_progress_step_reason.yml": { /** * The error code @@ -2473,8 +2473,8 @@ export interface external { * @example This is an error */ message?: string; - } - "resources/apps/models/apps_deployment_progress_step_status.yml": "UNKNOWN" | "PENDING" | "RUNNING" | "ERROR" | "SUCCESS" + }; + "resources/apps/models/apps_deployment_progress_step_status.yml": "UNKNOWN" | "PENDING" | "RUNNING" | "ERROR" | "SUCCESS"; "resources/apps/models/apps_deployment_progress_step.yml": { /** * The component name that this step is associated with @@ -2510,7 +2510,7 @@ export interface external { status?: external["resources/apps/models/apps_deployment_progress_step_status.yml"]; /** Child steps of this step */ steps?: Record[]; - } + }; "resources/apps/models/apps_deployment_progress.yml": { /** * Number of unsuccessful steps @@ -2546,10 +2546,10 @@ export interface external { * @example 5 */ total_steps?: number; - } + }; "resources/apps/models/apps_deployment_response.yml": { deployment?: external["resources/apps/models/apps_deployment.yml"]; - } + }; "resources/apps/models/apps_deployment_service.yml": { /** * The name of this service @@ -2561,7 +2561,7 @@ export interface external { * @example 54d4a727f457231062439895000d45437c7bb405 */ source_commit_hash?: string; - } + }; "resources/apps/models/apps_deployment_static_site.yml": { /** * The name of this static site @@ -2573,7 +2573,7 @@ export interface external { * @example 54d4a727f457231062439895000d45437c7bb405 */ source_commit_hash?: string; - } + }; "resources/apps/models/apps_deployment_worker.yml": { /** * The name of this worker @@ -2585,7 +2585,7 @@ export interface external { * @example 54d4a727f457231062439895000d45437c7bb405 */ source_commit_hash?: string; - } + }; "resources/apps/models/apps_deployment.yml": { /** * What caused this deployment to be created @@ -2638,16 +2638,16 @@ export interface external { updated_at?: string; /** Worker components that are part of this deployment */ workers?: external["resources/apps/models/apps_deployment_worker.yml"][]; - } + }; "resources/apps/models/apps_deployments_response.yml": { /** A list of deployments */ deployments?: external["resources/apps/models/apps_deployment.yml"][]; - } & external["shared/pages.yml"]["pagination"] & external["shared/meta.yml"] - "resources/apps/models/apps_domain_phase.yml": "UNKNOWN" | "PENDING" | "CONFIGURING" | "ACTIVE" | "ERROR" + } & external["shared/pages.yml"]["pagination"] & external["shared/meta.yml"]; + "resources/apps/models/apps_domain_phase.yml": "UNKNOWN" | "PENDING" | "CONFIGURING" | "ACTIVE" | "ERROR"; "resources/apps/models/apps_domain_progress.yml": { /** The steps of the domain's progress */ steps?: Record[]; - } + }; "resources/apps/models/apps_domain.yml": { /** * The ID of the domain @@ -2667,10 +2667,10 @@ export interface external { * @example 2024-01-29T23:59:59Z */ certificate_expires_at?: string; - } + }; "resources/apps/models/apps_get_instance_size_response.yml": { instance_size?: external["resources/apps/models/apps_instance_size.yml"]; - } + }; "resources/apps/models/apps_get_logs_response.yml": { /** A list of URLs to archived log files */ historic_urls?: string[]; @@ -2679,10 +2679,10 @@ export interface external { * @example ws://logs/build */ live_url?: string; - } + }; "resources/apps/models/apps_get_tier_response.yml": { tier?: external["resources/apps/models/apps_tier.yml"]; - } + }; "resources/apps/models/apps_git_source_spec.yml": { /** * @description The name of the branch to use @@ -2694,7 +2694,7 @@ export interface external { * @example https://github.com/digitalocean/sample-golang.git */ repo_clone_url?: string; - } + }; "resources/apps/models/apps_github_source_spec.yml": { /** * @description The name of the branch to use @@ -2711,7 +2711,7 @@ export interface external { * @example digitalocean/sample-golang */ repo?: string; - } + }; "resources/apps/models/apps_gitlab_source_spec.yml": { /** * @description The name of the branch to use @@ -2728,7 +2728,7 @@ export interface external { * @example digitalocean/sample-golang */ repo?: string; - } + }; "resources/apps/models/apps_image_source_spec.yml": { /** * @description The registry name. Must be left empty for the `DOCR` registry type. @@ -2753,7 +2753,7 @@ export interface external { * @example latest */ tag?: string; - } + }; "resources/apps/models/apps_instance_size.yml": { cpu_type?: external["resources/apps/models/instance_size_cpu_type.yml"]; /** @@ -2803,10 +2803,10 @@ export interface external { * @example 0.00000001232 */ usd_per_second?: string; - } + }; "resources/apps/models/apps_list_alerts_response.yml": { alerts?: external["resources/apps/models/app_alert.yml"][]; - } + }; "resources/apps/models/apps_list_instance_sizes_response.yml": { /** * Format: float @@ -2814,13 +2814,13 @@ export interface external { */ discount_percent?: number; instance_sizes?: external["resources/apps/models/apps_instance_size.yml"][]; - } + }; "resources/apps/models/apps_list_regions_response.yml": { regions?: external["resources/apps/models/apps_region.yml"][]; - } + }; "resources/apps/models/apps_list_tiers_response.yml": { tiers?: external["resources/apps/models/apps_tier.yml"][]; - } + }; "resources/apps/models/apps_region.yml": { /** * The continent that this region is in @@ -2864,11 +2864,11 @@ export interface external { * @example basic */ slug?: string; - } + }; "resources/apps/models/apps_response.yml": { /** A list of apps */ apps?: external["resources/apps/models/app.yml"][]; - } & external["shared/pages.yml"]["pagination"] & external["shared/meta.yml"] + } & external["shared/pages.yml"]["pagination"] & external["shared/meta.yml"]; "resources/apps/models/apps_rollback_app_request.yml": { /** * @description The ID of the deployment to rollback to. @@ -2880,7 +2880,7 @@ export interface external { * @example false */ skip_pin?: boolean; - } + }; "resources/apps/models/apps_string_match.yml": { /** * @description Exact string match. Only 1 of `exact`, `prefix`, or `regex` must be set. @@ -2897,7 +2897,7 @@ export interface external { * @example ^.*example.com */ regex?: string; - } + }; "resources/apps/models/apps_tier.yml": { /** * The amount of included build time in seconds @@ -2927,11 +2927,11 @@ export interface external { * @example 10000000 */ storage_bytes?: string; - } + }; "resources/apps/models/apps_update_app_request.yml": { spec: external["resources/apps/models/app_spec.yml"]; - } - "resources/apps/models/instance_size_cpu_type.yml": "UNSPECIFIED" | "SHARED" | "DEDICATED" + }; + "resources/apps/models/instance_size_cpu_type.yml": "UNSPECIFIED" | "SHARED" | "DEDICATED"; "resources/apps/parameters.yml": { accept?: "application/json" | "application/yaml"; "content-type"?: "application/json" | "application/yaml"; @@ -3310,7 +3310,7 @@ export interface external { * @example "2019-07-09T15:01:12.000Z" */ generated_at?: string; - } + }; "resources/billing/models/billing_address.yml": { /** * @description Street address line 1 @@ -3352,7 +3352,7 @@ export interface external { * @example "2019-09-03T16:34:46.000Z" */ updated_at?: string; - } + }; "resources/billing/models/billing_history.yml": { /** * @description Description of the billing history entry. @@ -3386,7 +3386,7 @@ export interface external { * @enum {string} */ type?: "ACHFailure" | "Adjustment" | "AttemptFailed" | "Chargeback" | "Credit" | "CreditExpiration" | "Invoice" | "Payment" | "Refund" | "Reversal"; - } + }; "resources/billing/models/invoice_item.yml": { /** * @description Name of the product being billed in the invoice item. @@ -3443,7 +3443,7 @@ export interface external { * @example web */ project_name?: string; - } + }; "resources/billing/models/invoice_preview.yml": { /** * @description The UUID of the invoice. The canonical reference for the invoice. @@ -3465,7 +3465,7 @@ export interface external { * @example "2020-01-23T06:31:50.000Z" */ updated_at?: string; - } + }; "resources/billing/models/invoice_summary.yml": { /** * @description UUID of the invoice @@ -3502,7 +3502,7 @@ export interface external { overages?: external["resources/billing/models/simple_charge.yml"]; taxes?: external["resources/billing/models/simple_charge.yml"]; credits_and_adjustments?: external["resources/billing/models/simple_charge.yml"]; - } + }; "resources/billing/models/product_charge_item.yml": { /** * @description Amount of the charge @@ -3519,7 +3519,7 @@ export interface external { * @example 1 */ count?: string; - } + }; "resources/billing/models/product_usage_charges.yml": { /** * @description Description of usage charges @@ -3547,7 +3547,7 @@ export interface external { * ] */ items?: external["resources/billing/models/product_charge_item.yml"][]; - } + }; "resources/billing/models/simple_charge.yml": { /** * @description Name of the charge @@ -3559,7 +3559,7 @@ export interface external { * @example 3.45 */ amount?: string; - } + }; "resources/billing/parameters.yml": { invoice_uuid: string; }; @@ -3827,7 +3827,7 @@ export interface external { * @example 2018-03-21T16:02:37Z */ created_at?: string; - } + }; "resources/cdn/models/purge_cache.yml": { /** * @description An array of strings containing the path to the content to be purged from the CDN cache. @@ -3837,7 +3837,7 @@ export interface external { * ] */ files: string[]; - } + }; "resources/cdn/models/update_endpoint.yml": { /** * @description The amount of time the content is cached by the CDN's edge servers in seconds. TTL must be one of 60, 600, 3600, 86400, or 604800. Defaults to 3600 (one hour) when excluded. @@ -3858,7 +3858,7 @@ export interface external { * @example static.example.com */ custom_domain?: string; - } + }; "resources/cdn/parameters.yml": { cdn_endpoint_id: string; }; @@ -4173,7 +4173,7 @@ export interface external { * @enum {string} */ type?: "custom" | "lets_encrypt"; - } + }; "resources/certificates/parameters.yml": { certificate_id: string; }; @@ -5353,14 +5353,14 @@ export interface external { * @example 0.03364864 */ size_gigabytes: number; - } + }; "resources/databases/models/ca.yml": { /** * @description base64 encoding of the certificate used to secure database connections * @example LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVRVENDQXFtZ0F3SUJBZ0lVRUZZWTdBWFZQS0Raam9jb1lpMk00Y0dvcU0wd0RRWUpLb1pJaHZjTkFRRU0KQlFBd09qRTRNRFlHQTFVRUF3d3ZOek0zT1RaaE1XRXRaamhrTUMwME9HSmpMV0V4Wm1NdFpqbGhNVFZsWXprdwpORGhsSUZCeWIycGxZM1FnUTBFd0hoY05NakF3TnpFM01UVTFNREEyV2hjTk16QXdOekUxTVRVMU1EQTJXakE2Ck1UZ3dOZ1lEVlFRRERDODNNemM1Tm1FeFlTMW1PR1F3TFRRNFltTXRZVEZtWXkxbU9XRXhOV1ZqT1RBME9HVWcKVUhKdmFtVmpkQ0JEUVRDQ0FhSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnR1BBRENDQVlvQ2dnR0JBTVdScXhycwpMZnpNdHZyUmxKVEw4MldYMVBLZkhKbitvYjNYcmVBY3FZd1dBUUp2Q3IycmhxSXZieVZzMGlaU0NzOHI4c3RGClljQ0R1bkxJNmUwTy9laERZYTBIT2RrMkFFRzE1ckVOVmNha2NSczcyQWlHVHNrdkNXS2VkUjFTUWswVWt0WCsKQUg4S1ExS3F5bzNtZ2Y2cVV1WUpzc3JNTXFselk3YTN1RVpEb2ZqTjN5Q3MvM21pTVJKcVcyNm1JV0IrUUlEbAo5YzdLRVF5MTZvdCtjeHVnd0lLMm9oZHMzaFY1bjBKMFVBM0I3QWRBdXY5aUl5L3JHaHlTNm5CNTdaWm9JZnAyCnFybXdOY0UrVjlIdXhQSGtRVjFOQjUwOFFudWZ4Z0E5VCtqU2VrdGVUbWFORkxqNjFXL3BtcndrTytOaWFXUTIKaGgzVXBKOEozY1BoNkErbHRnUmpSV2NEb2lsYVNwRVVpU09WemNNYVFvalZKYVJlNk9NbnZYc29NaSs3ZzdneApWcittQ0lUcGcvck9DaXpBWWQ2UFAxLzdYTjk1ZXNmU2tBQnM5c3hJakpjTUFqbDBYTEFzRmtGZVdyeHNIajlVCmJnaDNWYXdtcnpUeXhZT0RQcXV1cS9JcGlwc0RRT3Fpb2ZsUStkWEJJL3NUT0NNbVp6K0pNcG5HYXdJREFRQUIKb3o4d1BUQWRCZ05WSFE0RUZnUVVSekdDRlE3WEtUdHRDN3JzNS8ydFlQcExTZGN3RHdZRFZSMFRCQWd3QmdFQgovd0lCQURBTEJnTlZIUThFQkFNQ0FRWXdEUVlKS29aSWh2Y05BUUVNQlFBRGdnR0JBSWFKQ0dSVVNxUExtcmcvCmk3MW10b0NHUDdzeG1BVXVCek1oOEdrU25uaVdaZnZGMTRwSUtqTlkwbzVkWmpHKzZqK1VjalZtK0RIdGE1RjYKOWJPeEk5S0NFeEI1blBjRXpMWjNZYitNOTcrellxbm9zUm85S21DVFJBb2JrNTZ0WU1FS1h1aVJja2tkMm1yUQo4cGw2N2xxdThjM1V4c0dHZEZVT01wMkk3ZTNpdUdWVm5UR0ZWM3JQZUdaQ0J3WGVyUUQyY0F4UjkzS3BnWVZ2ClhUUzk5dnpSbm1HOHhhUm9EVy9FbEdXZ2xWd0Q5a1JrbXhUUkdoYTdDWVZCcjFQVWY2dVVFVjhmVFIxc1hFZnIKLytMR1JoSVVsSUhWT3l2Yzk3YnZYQURPbWF1MWZDVE5lWGtRdTNyZnZFSlBmaFlLeVIwT0V3eWVvdlhRNzl0LwpTV2ZGTjBreU1Pc1UrNVNIdHJKSEh1eWNWcU0yQlVVK083VjM1UnNwOU9MZGRZMFFVbTZldFpEVEhhSUhYYzRRCnl1Rm1OL1NhSFZtNE0wL3BTVlJQdVd6TmpxMnZyRllvSDRtbGhIZk95TUNJMjc2elE2aWhGNkdDSHlkOUJqajcKUm1UWGEyNHM3NWhmSi9YTDV2bnJSdEtpVHJlVHF6V21EOVhnUmNMQ0gyS1hJaVRtSWc9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg== */ certificate: string; - } + }; "resources/databases/models/connection_pool_update.yml": { /** * @description The PGBouncer transaction mode for the connection pool. The allowed values are session, transaction, and statement. @@ -5383,7 +5383,7 @@ export interface external { * @example doadmin */ user?: string; - } + }; "resources/databases/models/connection_pool.yml": { /** * @description A unique name for the connection pool. Must be between 3 and 60 characters. @@ -5413,11 +5413,11 @@ export interface external { user?: string; connection?: external["resources/databases/models/database_connection.yml"]; private_connection?: external["resources/databases/models/database_connection.yml"]; - } + }; "resources/databases/models/connection_pools.yml": { /** @description An array of connection pool objects. */ pools?: readonly external["resources/databases/models/connection_pool.yml"][]; - } + }; "resources/databases/models/database_backup.yml": { /** * @description The name of an existing database cluster from which the backup will be restored. @@ -5430,7 +5430,7 @@ export interface external { * @example "2019-01-31T19:25:22.000Z" */ backup_created_at?: string; - } + }; "resources/databases/models/database_cluster_resize.yml": { /** * @description A slug identifier representing desired the size of the nodes in the database cluster. @@ -5443,7 +5443,7 @@ export interface external { * @example 3 */ num_nodes: number; - } + }; "resources/databases/models/database_cluster.yml": { /** * Format: uuid @@ -5539,10 +5539,10 @@ export interface external { * @example 2023-05-09T00:00:00Z */ version_end_of_availability?: string; - } + }; "resources/databases/models/database_config.yml": { config?: external["resources/databases/models/mysql.yml"] | external["resources/databases/models/postgres.yml"] | external["resources/databases/models/redis.yml"]; - } + }; "resources/databases/models/database_connection.yml": { /** * @description A connection string in the format accepted by the `psql` command. This is provided as a convenience and should be able to be constructed by the other attributes. @@ -5579,7 +5579,7 @@ export interface external { * @example true */ ssl?: boolean; - } + }; "resources/databases/models/database_layout_option.yml": { /** @example 1 */ num_nodes?: number; @@ -5591,11 +5591,11 @@ export interface external { * ] */ sizes?: readonly string[]; - } + }; "resources/databases/models/database_layout_options.yml": { /** @description An array of objects, each indicating the node sizes (otherwise referred to as slugs) that are available with various numbers of nodes in the database cluster. Each slugs denotes the node's identifier, CPU, and RAM (in that order). */ layouts?: readonly external["resources/databases/models/database_layout_option.yml"][]; - } + }; "resources/databases/models/database_maintenance_window.yml": { /** * @description The day of the week on which to apply maintenance updates. @@ -5620,7 +5620,7 @@ export interface external { * ] */ description?: readonly string[]; - } | null + } | null; "resources/databases/models/database_region_options.yml": { /** * @description An array of strings containing the names of available regions @@ -5630,7 +5630,7 @@ export interface external { * ] */ regions?: readonly string[]; - } + }; "resources/databases/models/database_replica.yml": { /** * Format: uuid @@ -5679,7 +5679,7 @@ export interface external { private_network_uuid?: string; connection?: external["resources/databases/models/database_connection.yml"]; private_connection?: external["resources/databases/models/database_connection.yml"]; - } + }; "resources/databases/models/database_user.yml": { /** * @description The name of a database user. @@ -5700,8 +5700,8 @@ export interface external { */ password?: string; mysql_settings?: external["resources/databases/models/mysql_settings.yml"]; - } - "resources/databases/models/database_version_availabilities.yml": external["resources/databases/models/database_version_availability.yml"][] + }; + "resources/databases/models/database_version_availabilities.yml": external["resources/databases/models/database_version_availability.yml"][]; "resources/databases/models/database_version_availability.yml": { /** * @description A timestamp referring to the date when the particular version will no longer be supported. If null, the version does not have an end of life timeline. @@ -5718,7 +5718,7 @@ export interface external { * @example 8 */ version?: string; - } + }; "resources/databases/models/database_version_options.yml": { /** * @description An array of strings containing the names of available regions @@ -5728,15 +5728,15 @@ export interface external { * ] */ versions?: readonly string[]; - } + }; "resources/databases/models/database.yml": { /** * @description The name of the database. * @example alpha */ name: string; - } - "resources/databases/models/eviction_policy_model.yml": "noeviction" | "allkeys_lru" | "allkeys_random" | "volatile_lru" | "volatile_random" | "volatile_ttl" + }; + "resources/databases/models/eviction_policy_model.yml": "noeviction" | "allkeys_lru" | "allkeys_random" | "volatile_lru" | "volatile_random" | "volatile_ttl"; "resources/databases/models/firewall_rule.yml": { /** * @description A unique ID for the firewall rule itself. @@ -5765,7 +5765,7 @@ export interface external { * @example "2019-01-11T18:37:36.000Z" */ created_at?: string; - } + }; "resources/databases/models/mysql_settings.yml": { /** * @description A string specifying the authentication method to be used for connections @@ -5778,7 +5778,7 @@ export interface external { * @enum {string} */ auth_plugin: "mysql_native_password" | "caching_sha2_password"; - } + }; "resources/databases/models/mysql.yml": { /** * @description The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed. @@ -5916,7 +5916,7 @@ export interface external { * @example 600 */ binlog_retention_period?: number; - } + }; "resources/databases/models/online_migration.yml": { /** * @description The ID of the most recent migration. @@ -5934,7 +5934,7 @@ export interface external { * @example "2020-10-29T15:57:38.000Z" */ created_at?: string; - } + }; "resources/databases/models/options.yml": { options?: { mongodb?: external["resources/databases/models/database_region_options.yml"] & external["resources/databases/models/database_version_options.yml"] & external["resources/databases/models/database_layout_options.yml"]; @@ -5948,7 +5948,7 @@ export interface external { redis?: external["resources/databases/models/database_version_availabilities.yml"]; mongodb?: external["resources/databases/models/database_version_availabilities.yml"]; }; - } + }; "resources/databases/models/pgbouncer.yml": { /** * @description Run server_reset_query (DISCARD ALL) in all pooling modes. @@ -5999,7 +5999,7 @@ export interface external { * @example 3600 */ autodb_idle_timeout?: number; - } + }; "resources/databases/models/postgres.yml": { /** * @description Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted. @@ -6266,7 +6266,7 @@ export interface external { * @example false */ stat_monitor_enable?: boolean; - } + }; "resources/databases/models/redis.yml": { redis_maxmemory_policy?: external["resources/databases/models/eviction_policy_model.yml"]; /** @@ -6326,7 +6326,7 @@ export interface external { * @enum {string} */ redis_acl_channels_default?: "allchannels" | "resetchannels"; - } + }; "resources/databases/models/source_database.yml": { source?: { /** @@ -6360,24 +6360,24 @@ export interface external { * @example false */ disable_ssl?: boolean; - } + }; "resources/databases/models/sql_mode.yml": { /** * @description A string specifying the configured SQL modes for the MySQL cluster. * @example ANSI,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,STRICT_ALL_TABLES */ sql_mode: string; - } + }; "resources/databases/models/timescaledb.yml": { /** * @description The number of background workers for timescaledb operations. Set to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time. * @example 8 */ max_background_workers?: number; - } + }; "resources/databases/models/version.yml": { version?: external["resources/databases/models/database_cluster.yml"]["version"]; - } + }; "resources/databases/parameters.yml": { database_cluster_uuid: string; database_name: string; @@ -6927,7 +6927,7 @@ export interface external { * @example null */ tag?: string | null; - } + }; "resources/domains/models/domain.yml": { /** * @description The name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, `example.com` is a valid domain name. @@ -6955,7 +6955,7 @@ export interface external { * example.com. 1800 IN A 1.2.3.4 */ zone_file?: string | null; - } + }; "resources/domains/parameters.yml": { domain_name: string; domain_record_id: number; @@ -7636,7 +7636,7 @@ export interface external { * @example 0 */ failures?: number; - } + }; "resources/droplets/models/associated_resource.yml": { /** * @description The unique identifier for the resource associated with the Droplet. @@ -7653,7 +7653,7 @@ export interface external { * @example 0.05 */ cost?: string; - } + }; "resources/droplets/models/destroyed_associated_resource.yml": { /** * @description The unique identifier for the resource scheduled for deletion. @@ -7676,7 +7676,7 @@ export interface external { * @example */ error_message?: string; - } + }; "resources/droplets/models/droplet_actions.yml": { /** @description Specifies the action that will be taken on the Droplet. */ droplet_action: { /** @@ -7818,7 +7818,7 @@ export interface external { * @example true */ with_droplet_agent?: boolean; - } + }; "resources/droplets/models/droplet_multi_create.yml": { /** * @description An array of human human-readable strings you wish to use when displaying the Droplet name. Each name, if set to a domain name managed in the DigitalOcean DNS management system, will configure a PTR record for the Droplet. Each name set during creation will also determine the hostname for the Droplet in its internal configuration. @@ -7828,14 +7828,14 @@ export interface external { * ] */ names: string[]; - } & external["resources/droplets/models/droplet_create.yml"] + } & external["resources/droplets/models/droplet_create.yml"]; "resources/droplets/models/droplet_single_create.yml": { /** * @description The human-readable string you wish to use when displaying the Droplet name. The name, if set to a domain name managed in the DigitalOcean DNS management system, will configure a PTR record for the Droplet. The name set during creation will also determine the hostname for the Droplet in its internal configuration. * @example example.com */ name: string; - } & external["resources/droplets/models/droplet_create.yml"] + } & external["resources/droplets/models/droplet_create.yml"]; "resources/droplets/models/droplet_snapshot.yml": { /** * @description The unique identifier for the snapshot or backup. @@ -7849,7 +7849,7 @@ export interface external { * @enum {string} */ type: "snapshot" | "backup"; - }) + }); "resources/droplets/models/droplet.yml": { /** * @description A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation. @@ -7965,7 +7965,7 @@ export interface external { * @example 760e09ef-dc84-11e8-981e-3cfdfeaae000 */ vpc_uuid?: string; - } + }; "resources/droplets/models/kernel.yml": { /** * @description A unique number used to identify and reference a specific kernel. @@ -7982,7 +7982,7 @@ export interface external { * @example 2016.07.13-DigitalOcean_loader_Ubuntu */ version?: string; - } | null + } | null; "resources/droplets/models/neighbor_ids.yml": { /** * @description An array of arrays. Each array will contain a set of Droplet IDs for Droplets that share a physical server. @@ -7999,7 +7999,7 @@ export interface external { * ] */ neighbor_ids?: number[][]; - } + }; "resources/droplets/models/network_v4.yml": { /** * Format: ipv4 @@ -8028,7 +8028,7 @@ export interface external { * @enum {string} */ type?: "public" | "private"; - } + }; "resources/droplets/models/network_v6.yml": { /** * Format: ipv6 @@ -8056,7 +8056,7 @@ export interface external { * @enum {string} */ type?: "public"; - } + }; "resources/droplets/models/selective_destroy_associated_resource.yml": { /** * @deprecated @@ -8094,7 +8094,7 @@ export interface external { * ] */ volume_snapshots?: string[]; - } + }; "resources/droplets/parameters.yml": { droplet_id: number; droplet_tag_name?: string; @@ -8765,7 +8765,7 @@ export interface external { default: external["shared/responses/unexpected_error.yml"]; }; } - "resources/firewalls/models/firewall_rule.yml": unknown + "resources/firewalls/models/firewall_rule.yml": unknown; "resources/firewalls/models/firewall.yml": ({ /** * @description A unique ID that can be used to identify and reference a firewall. @@ -8815,7 +8815,7 @@ export interface external { */ droplet_ids?: number[] | null; tags?: external["shared/attributes/tags_array.yml"]; - }) & external["resources/firewalls/models/firewall_rule.yml"]["firewall_rules"] + }) & external["resources/firewalls/models/firewall_rule.yml"]["firewall_rules"]; "resources/firewalls/parameters.yml": { firewall_id: string; }; @@ -9066,7 +9066,7 @@ export interface external { * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 */ project_id?: string; - }]> + }]>; "resources/floating_ips/models/floating_ip.yml": { /** * Format: ipv4 @@ -9091,7 +9091,7 @@ export interface external { * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 */ project_id?: string; - } + }; "resources/floating_ips/parameters.yml": { floating_ip: string; }; @@ -9365,7 +9365,7 @@ export interface external { * @example my namespace */ label: string; - } + }; "resources/functions/models/create_trigger.yml": { /** * @description The trigger's unique name within the namespace. @@ -9388,7 +9388,7 @@ export interface external { */ is_enabled: boolean; scheduled_details: external["resources/functions/models/scheduled_details.yml"]; - } + }; "resources/functions/models/namespace_info.yml": { /** * @description The namespace's API hostname. Each function in a namespace is provided an endpoint at the namespace's hostname. @@ -9431,7 +9431,7 @@ export interface external { * @example d1zcd455h01mqjfs4s2eaewyejehi5f2uj4etqq3h7cera8iwkub6xg5of1wdde2 */ key?: string; - } + }; "resources/functions/models/scheduled_details.yml": { /** * @description valid cron expression string which is required for SCHEDULED type triggers. @@ -9443,7 +9443,7 @@ export interface external { /** @example Welcome to DO! */ name?: string; } | null; - } + }; "resources/functions/models/trigger_info.yml": { /** * @description A unique string format of UUID with a prefix fn-. @@ -9493,7 +9493,7 @@ export interface external { */ next_run_at?: string | null; }; - } + }; "resources/functions/models/update_trigger.yml": { /** * @description Indicates weather the trigger is paused or unpaused. @@ -9501,7 +9501,7 @@ export interface external { */ is_enabled?: boolean; scheduled_details?: external["resources/functions/models/scheduled_details.yml"]; - } + }; "resources/functions/parameters.yml": { namespace_id: string; trigger_name: string; @@ -9624,7 +9624,7 @@ export interface external { }; }; } - "resources/images/attributes.yml": unknown + "resources/images/attributes.yml": unknown; /** * Retrieve an Existing Action * @description To retrieve the status of an image action, send a GET request to `/v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_ID`. @@ -9862,12 +9862,12 @@ export interface external { url?: string; region?: external["shared/attributes/region_slug.yml"]; tags?: external["shared/attributes/tags_array.yml"]; - }, "name" | "url" | "region"> + }, "name" | "url" | "region">; "resources/images/models/image_update.yml": { name?: external["resources/images/attributes.yml"]["image_name"]; distribution?: external["shared/attributes/distribution.yml"]; description?: external["resources/images/attributes.yml"]["image_description"]; - } + }; "resources/images/models/image.yml": { /** * @description A unique number that can be used to identify and reference a specific image. @@ -9925,7 +9925,7 @@ export interface external { * @example */ error_message?: string; - } + }; "resources/images/parameters.yml": Record "resources/images/responses/all_images.yml": { headers: { @@ -10739,7 +10739,7 @@ export interface external { * ] */ cluster_uuids?: string[]; - } + }; "resources/kubernetes/models/cluster_update.yml": { /** * @description A human-readable name for a Kubernetes cluster. @@ -10775,7 +10775,7 @@ export interface external { * @example true */ ha?: boolean; - } + }; "resources/kubernetes/models/cluster.yml": { /** * Format: uuid @@ -10887,7 +10887,7 @@ export interface external { * @example true */ registry_enabled?: boolean; - } + }; "resources/kubernetes/models/clusterlint_request.yml": { /** * @description An array of check groups that will be run when clusterlint executes checks. @@ -10920,7 +10920,7 @@ export interface external { * ] */ exclude_checks?: string[]; - } + }; "resources/kubernetes/models/clusterlint_results.yml": { /** * @description Id of the clusterlint run that can be used later to fetch the diagnostics. @@ -10975,7 +10975,7 @@ export interface external { namespace?: string; }; }[]; - } + }; "resources/kubernetes/models/credentials.yml": { /** * Format: uri @@ -11028,7 +11028,7 @@ export interface external { * @example "2019-11-09T11:50:28.889Z" */ expires_at?: string; - } + }; "resources/kubernetes/models/maintenance_policy.yml": ({ /** * @description The start time in UTC of the maintenance window policy in 24-hour clock format / HH:MM notation (e.g., `15:00`). @@ -11046,8 +11046,8 @@ export interface external { * @enum {string} */ day?: "any" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"; - }) | null - "resources/kubernetes/models/node_pool.yml": unknown + }) | null; + "resources/kubernetes/models/node_pool.yml": unknown; "resources/kubernetes/models/node.yml": { /** * Format: uuid @@ -11086,8 +11086,8 @@ export interface external { * @example 2018-11-15T16:00:11Z */ updated_at?: string; - } - "resources/kubernetes/models/options.yml": unknown + }; + "resources/kubernetes/models/options.yml": unknown; "resources/kubernetes/models/user.yml": { kubernetes_cluster_user?: { /** @@ -11104,7 +11104,7 @@ export interface external { */ groups?: string[]; }; - } + }; "resources/kubernetes/parameters.yml": { kubernetes_cluster_id: string; kubernetes_node_pool_id: string; @@ -11555,7 +11555,7 @@ export interface external { default: external["shared/responses/unexpected_error.yml"]; }; } - "resources/load_balancers/models/attributes.yml": unknown + "resources/load_balancers/models/attributes.yml": unknown; "resources/load_balancers/models/forwarding_rule.yml": { /** * @description The protocol used for traffic to the load balancer. The possible values are: `http`, `https`, `http2`, `http3`, `tcp`, or `udp`. If you set the `entry_protocol` to `udp`, the `target_protocol` must be set to `udp`. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly. @@ -11591,7 +11591,7 @@ export interface external { * @example false */ tls_passthrough?: boolean; - } + }; "resources/load_balancers/models/health_check.yml": { /** * @description The protocol used for health checks sent to the backend Droplets. The possible values are `http`, `https`, or `tcp`. @@ -11636,7 +11636,7 @@ export interface external { * @example 3 */ healthy_threshold?: number; - } + }; "resources/load_balancers/models/lb_firewall.yml": { /** * @description the rules for denying traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16') @@ -11656,7 +11656,7 @@ export interface external { * ] */ allow?: string[]; - } + }; "resources/load_balancers/models/load_balancer_base.yml": { /** * Format: uuid @@ -11759,7 +11759,7 @@ export interface external { */ disable_lets_encrypt_dns_records?: boolean; firewall?: external["resources/load_balancers/models/lb_firewall.yml"]; - } + }; "resources/load_balancers/models/load_balancer_create.yml": OneOf<[WithRequired<{ $ref?: external["resources/load_balancers/models/attributes.yml"]["load_balancer_droplet_ids"]; } & { @@ -11768,14 +11768,14 @@ export interface external { $ref?: external["resources/load_balancers/models/attributes.yml"]["load_balancer_droplet_tag"]; } & { region?: external["shared/attributes/region_slug.yml"]; - } & external["resources/load_balancers/models/load_balancer_base.yml"], "tag" | "region">]> + } & external["resources/load_balancers/models/load_balancer_base.yml"], "tag" | "region">]>; "resources/load_balancers/models/load_balancer.yml": external["resources/load_balancers/models/load_balancer_base.yml"] & { region?: external["resources/regions/models/region.yml"]; } & { $ref?: external["resources/load_balancers/models/attributes.yml"]["load_balancer_droplet_ids"]; } & { $ref?: external["resources/load_balancers/models/attributes.yml"]["load_balancer_droplet_tag"]; - } + }; "resources/load_balancers/models/sticky_sessions.yml": { /** * @description An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are `cookies` or `none`. @@ -11794,7 +11794,7 @@ export interface external { * @example 300 */ cookie_ttl_seconds?: number; - } + }; "resources/load_balancers/parameters.yml": { load_balancer_id: string; }; @@ -11885,7 +11885,7 @@ export interface external { * @enum {string} */ window: "5m" | "10m" | "30m" | "1h"; - } + }; "resources/monitoring/models/alert_policy.yml": { alerts: external["resources/monitoring/models/alerts.yml"]; /** @@ -11926,7 +11926,7 @@ export interface external { * @enum {string} */ window: "5m" | "10m" | "30m" | "1h"; - } + }; "resources/monitoring/models/alerts.yml": { /** * @description An email to notify on an alert trigger. @@ -11937,10 +11937,10 @@ export interface external { email: string[]; /** @description Slack integration details. */ slack: external["resources/monitoring/models/slack_details.yml"][]; - } + }; "resources/monitoring/models/list_alert_policy.yml": { policies: external["resources/monitoring/models/alert_policy.yml"][]; - } + }; "resources/monitoring/models/metrics_data.yml": { /** @description Result of query. */ result: external["resources/monitoring/models/metrics_result.yml"][]; @@ -11949,7 +11949,7 @@ export interface external { * @enum {string} */ resultType: "matrix"; - } + }; "resources/monitoring/models/metrics_result.yml": { /** * @description An object containing the metric labels. @@ -11973,7 +11973,7 @@ export interface external { * ] */ values: ((number | string)[])[]; - } + }; "resources/monitoring/models/metrics.yml": { data: external["resources/monitoring/models/metrics_data.yml"]; /** @@ -11981,7 +11981,7 @@ export interface external { * @enum {string} */ status: "success" | "error"; - } + }; "resources/monitoring/models/slack_details.yml": { /** * @description Slack channel to notify of an alert trigger. @@ -11993,7 +11993,7 @@ export interface external { * @example https://hooks.slack.com/services/T1234567/AAAAAAAA/ZZZZZZ */ url: string; - } + }; /** * Create Alert Policy * @description To create a new alert, send a POST request to `/v2/monitoring/alerts`. @@ -12462,8 +12462,8 @@ export interface external { * ] */ resources?: external["shared/attributes/urn.yml"][]; - } - "resources/projects/models/project.yml": unknown + }; + "resources/projects/models/project.yml": unknown; "resources/projects/models/resource.yml": { urn?: external["shared/attributes/urn.yml"]; /** @@ -12487,7 +12487,7 @@ export interface external { * @enum {string} */ status?: "ok" | "not_found" | "assigned" | "already_assigned" | "service_down"; - } + }; "resources/projects/parameters.yml": { project_id: string; }; @@ -12881,7 +12881,7 @@ export interface external { * ] */ sizes: unknown; - } + }; /** * List All Data Center Regions * @description To list all of the regions that are available, send a GET request to `/v2/regions`. @@ -12924,7 +12924,7 @@ export interface external { auth?: string; }; }; - } + }; "resources/registry/models/garbage_collection.yml": { /** * @description A string specifying the UUID of the garbage collection. @@ -12964,7 +12964,7 @@ export interface external { * @example 667 */ freed_bytes?: number; - } + }; "resources/registry/models/registry_create.yml": { /** * @description A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. @@ -12983,7 +12983,7 @@ export interface external { * @enum {string} */ region?: "nyc3" | "sfo3" | "ams3" | "sgp1" | "fra1"; - } + }; "resources/registry/models/registry.yml": { /** * @description A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. @@ -13013,7 +13013,7 @@ export interface external { */ storage_usage_bytes_updated_at?: string; subscription?: external["resources/registry/models/subscription.yml"]; - } + }; "resources/registry/models/repository_blob.yml": { /** * @description The digest of the blob @@ -13025,7 +13025,7 @@ export interface external { * @example 2803255 */ compressed_size_bytes?: number; - } + }; "resources/registry/models/repository_manifest.yml": { /** * @description The name of the container registry. @@ -13069,7 +13069,7 @@ export interface external { tags?: string[]; /** @description All blobs associated with this manifest */ blobs?: external["resources/registry/models/repository_blob.yml"][]; - } + }; "resources/registry/models/repository_tag.yml": { /** * @description The name of the container registry. @@ -13107,7 +13107,7 @@ export interface external { * @example 2020-04-09T23:54:25Z */ updated_at?: string; - } + }; "resources/registry/models/repository_v2.yml": { /** * @description The name of the container registry. @@ -13130,7 +13130,7 @@ export interface external { * @example 1 */ manifest_count?: number; - } + }; "resources/registry/models/repository.yml": { /** * @description The name of the container registry. @@ -13148,8 +13148,8 @@ export interface external { * @example 1 */ tag_count?: number; - } - "resources/registry/models/subscription_tier.yml": unknown + }; + "resources/registry/models/subscription_tier.yml": unknown; "resources/registry/models/subscription.yml": { tier?: external["resources/registry/models/subscription_tier.yml"]["subscription_tier_base"]; /** @@ -13164,21 +13164,21 @@ export interface external { * @example 2020-11-05T15:53:24Z */ updated_at?: string; - } + }; "resources/registry/models/update_registry.yml": { /** * @description A boolean value indicating that the garbage collection should be cancelled. * @example true */ cancel?: boolean; - } + }; "resources/registry/models/validate_registry.yml": { /** * @description A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. * @example example */ name: string; - } + }; "resources/registry/parameters.yml": { registry_expiry_seconds?: number; registry_read_write?: boolean; @@ -13800,7 +13800,7 @@ export interface external { * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 */ project_id?: string; - }]> + }]>; "resources/reserved_ips/models/reserved_ip.yml": { /** * Format: ipv4 @@ -13825,7 +13825,7 @@ export interface external { * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 */ project_id?: string; - } + }; "resources/reserved_ips/parameters.yml": { reserved_ip: string; }; @@ -14130,7 +14130,7 @@ export interface external { * @example Basic */ description: string; - } + }; "resources/sizes/responses/all_sizes.yml": { headers: { "ratelimit-limit": external["shared/headers.yml"]["ratelimit-limit"]; @@ -14194,7 +14194,7 @@ export interface external { * @example 2.34 */ size_gigabytes: number; - } + }; "resources/snapshots/models/snapshots.yml": { /** * @description The unique identifier for the snapshot. @@ -14221,7 +14221,7 @@ export interface external { * ] */ tags: string[] | null; - }) + }); "resources/snapshots/parameters.yml": { snapshot_resource_type?: "droplet" | "volume"; snapshot_id: number | string; @@ -14337,9 +14337,9 @@ export interface external { default: external["shared/responses/unexpected_error.yml"]; }; } - "resources/ssh_keys/attributes/ssh_key_fingerprint.yml": string - "resources/ssh_keys/attributes/ssh_key_id.yml": number - "resources/ssh_keys/attributes/ssh_key_name.yml": string + "resources/ssh_keys/attributes/ssh_key_fingerprint.yml": string; + "resources/ssh_keys/attributes/ssh_key_id.yml": number; + "resources/ssh_keys/attributes/ssh_key_name.yml": string; "resources/ssh_keys/links/sshKeys_delete_by_fingerprint.yml": { content: never; } @@ -14361,7 +14361,7 @@ export interface external { */ public_key: string; name: external["resources/ssh_keys/attributes/ssh_key_name.yml"]; - } + }; "resources/ssh_keys/parameters/ssh_key_identifier.yml": unknown "resources/ssh_keys/responses/sshKeys_all.yml": { headers: { @@ -14514,7 +14514,7 @@ export interface external { * @example https://api.digitalocean.com/v2/images/7555620 */ last_tagged_uri?: string; - } + }; "resources/tags/models/tags_resource.yml": { /** * @description An array of objects containing resource_id and resource_type attributes. @@ -14546,7 +14546,7 @@ export interface external { */ resource_type?: "droplet" | "image" | "volume" | "volume_snapshot"; })[]; - } + }; "resources/tags/models/tags.yml": { /** * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. @@ -14595,7 +14595,7 @@ export interface external { volume_snapshots?: external["resources/tags/models/tags_metadata.yml"]; databases?: external["resources/tags/models/tags_metadata.yml"]; }; - } + }; "resources/tags/parameters.yml": { tag_id: string; }; @@ -14970,8 +14970,8 @@ export interface external { default: external["shared/responses/unexpected_error.yml"]; }; } - "resources/uptime/models/alert.yml": unknown - "resources/uptime/models/check.yml": unknown + "resources/uptime/models/alert.yml": unknown; + "resources/uptime/models/check.yml": unknown; "resources/uptime/models/notification.yml": { /** * @description An email to notify on an alert trigger. @@ -14995,8 +14995,8 @@ export interface external { */ url: string; }[]; - } - "resources/uptime/models/state.yml": unknown + }; + "resources/uptime/models/state.yml": unknown; "resources/uptime/parameters.yml": { check_id: string; alert_id: string; @@ -15111,11 +15111,11 @@ export interface external { }; } "resources/volumes/examples.yml": unknown - "resources/volumes/models/attributes.yml": unknown + "resources/volumes/models/attributes.yml": unknown; "resources/volumes/models/volume_action_post_attach.yml": external["resources/volumes/models/volume_action_post_base.yml"] & { droplet_id: external["resources/volumes/models/attributes.yml"]["volume_action_droplet_id"]; tags?: external["shared/attributes/tags_array.yml"]; - } + }; "resources/volumes/models/volume_action_post_base.yml": { /** * @description The volume action to initiate. @@ -15124,14 +15124,14 @@ export interface external { */ type: "attach" | "detach" | "resize"; region?: external["shared/attributes/region_slug.yml"]; - } + }; "resources/volumes/models/volume_action_post_detach.yml": external["resources/volumes/models/volume_action_post_base.yml"] & { droplet_id: external["resources/volumes/models/attributes.yml"]["volume_action_droplet_id"]; - } + }; "resources/volumes/models/volume_action_post_resize.yml": external["resources/volumes/models/volume_action_post_base.yml"] & { /** @description The new size of the block storage volume in GiB (1024^3). */ size_gigabytes: number; - } + }; "resources/volumes/models/volume_base.yml": { /** * @description The unique identifier for the block storage volume. @@ -15164,7 +15164,7 @@ export interface external { */ created_at?: string; tags?: external["shared/attributes/tags_array.yml"]; - } + }; "resources/volumes/models/volume_full.yml": external["resources/volumes/models/volume_base.yml"] & { /** * @example { @@ -15206,7 +15206,7 @@ export interface external { * @example example */ filesystem_label?: string; - } + }; "resources/volumes/models/volumeAction.yml": ({ /** * @description This is the type of action that the object represents. For example, this could be "attach_volume" to represent the state of a volume attach action. @@ -15215,15 +15215,15 @@ export interface external { type?: string; /** @example null */ resource_id?: number | null; - }) & external["resources/actions/models/action.yml"] + }) & external["resources/actions/models/action.yml"]; "resources/volumes/models/volumes_ext4.yml": external["resources/volumes/models/volume_base.yml"] & external["resources/volumes/models/attributes.yml"]["volume_snapshot_id"] & external["resources/volumes/models/attributes.yml"]["volume_write_file_system_type"] & { region: external["shared/attributes/region_slug.yml"]; filesystem_label?: external["resources/volumes/models/attributes.yml"]["volume_write_file_system_label"]; - } + }; "resources/volumes/models/volumes_xfs.yml": external["resources/volumes/models/volume_base.yml"] & external["resources/volumes/models/attributes.yml"]["volume_snapshot_id"] & external["resources/volumes/models/attributes.yml"]["volume_write_file_system_type"] & { region: external["shared/attributes/region_slug.yml"]; filesystem_label?: external["resources/volumes/models/attributes.yml"]["volume_write_file_system_label"]; - } + }; "resources/volumes/parameters.yml": { volume_id: string; volume_name?: string; @@ -15687,8 +15687,8 @@ export interface external { * @example 2020-03-13T19:30:48Z */ created_at?: string; - } - "resources/vpcs/models/vpc.yml": unknown + }; + "resources/vpcs/models/vpc.yml": unknown; "resources/vpcs/parameters.yml": { vpc_id: string; vpc_resource_type?: string; @@ -15894,11 +15894,11 @@ export interface external { default: external["shared/responses/unexpected_error.yml"]; }; } - "shared/attributes/distribution.yml": "Arch Linux" | "CentOS" | "CoreOS" | "Debian" | "Fedora" | "Fedora Atomic" | "FreeBSD" | "Gentoo" | "openSUSE" | "RancherOS" | "Rocky Linux" | "Ubuntu" | "Unknown" + "shared/attributes/distribution.yml": "Arch Linux" | "CentOS" | "CoreOS" | "Debian" | "Fedora" | "Fedora Atomic" | "FreeBSD" | "Gentoo" | "openSUSE" | "RancherOS" | "Rocky Linux" | "Ubuntu" | "Unknown"; "shared/attributes/region_slug.yml": "ams1" | "ams2" | "ams3" | "blr1" | "fra1" | "lon1" | "nyc1" | "nyc2" | "nyc3" | "sfo1" | "sfo2" | "sfo3" | "sgp1" | "tor1" - "shared/attributes/regions_array.yml": external["shared/attributes/region_slug.yml"][] - "shared/attributes/tags_array.yml": string[] | null - "shared/attributes/urn.yml": string + "shared/attributes/regions_array.yml": external["shared/attributes/region_slug.yml"][]; + "shared/attributes/tags_array.yml": string[] | null; + "shared/attributes/urn.yml": string; "shared/headers.yml": { /** * @description Indicates if the content is expected to be displayed *inline* in the browser, that is, as a Web page or as part of a Web page, or as an *attachment*, that is downloaded and saved locally. @@ -15927,10 +15927,10 @@ export interface external { }; "shared/meta_optional_total.yml": { meta: external["shared/models/meta_properties.yml"]; - } + }; "shared/meta.yml": { meta: external["shared/models/meta_properties.yml"]; - } + }; "shared/models/action_link.yml": { /** * @description A unique numeric ID that can be used to identify and reference an action. @@ -15948,7 +15948,7 @@ export interface external { * @example https://api.digitalocean.com/v2/actions/7515 */ href?: string; - } + }; "shared/models/error_with_root_causes.yml": { /** * @description A message providing information about the error. @@ -15965,7 +15965,7 @@ export interface external { * @example [] */ root_causes: string[]; - } + }; "shared/models/error.yml": { /** * @description A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found." @@ -15982,14 +15982,14 @@ export interface external { * @example 4d9d8375-3c56-4925-a3e7-eb137fed17e9 */ request_id?: string; - } + }; "shared/models/meta_properties.yml": { /** * @description Number of objects returned by the request. * @example 1 */ total?: number; - } + }; "shared/pages.yml": { pagination: { links?: external["shared/pages.yml"]["page_links"]; diff --git a/packages/openapi-typescript/examples/digital-ocean-api/description.yml b/packages/openapi-typescript/examples/digital-ocean-api/description.yml index 57375a7bc..eb69dcbbc 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/description.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/description.yml @@ -227,7 +227,9 @@ introduction: | If the `ratelimit-remaining` reaches zero, subsequent requests will receive a 429 error code until the request reset has been reached. You can see the - format of the response in the examples. + format of the response in the examples. `ratelimit-remaining` reaching zero + can also indicate that the 250 requests per minute limit was met, even if + the 5,000 requests per hour limit was not. **Note:** The following endpoints have special rate limit requirements that are independent of the limits defined above. diff --git a/packages/openapi-typescript/examples/github-api-next.ts b/packages/openapi-typescript/examples/github-api-next.ts index 09a8af419..7e04c3119 100644 --- a/packages/openapi-typescript/examples/github-api-next.ts +++ b/packages/openapi-typescript/examples/github-api-next.ts @@ -20,7 +20,9 @@ export interface paths { "/advisories": { /** * List global security advisories - * @description List global security advisories and filter using parameters such as ecosystem, GHSA ID, CVE ID, etc. + * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. + * + * 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)." */ get: operations["security-advisories/list-global-advisories"]; }; @@ -116,7 +118,7 @@ export interface paths { get: operations["apps/get-installation"]; /** * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. + * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. * * 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. */ @@ -360,7 +362,7 @@ export interface paths { * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app)" endpoint. + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. * * 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. */ @@ -382,11 +384,17 @@ export interface paths { get: operations["issues/list"]; }; "/licenses": { - /** Get all commonly used licenses */ + /** + * Get all commonly used licenses + * @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)." + */ get: operations["licenses/get-all-commonly-used"]; }; "/licenses/{license}": { - /** Get a license */ + /** + * Get a license + * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + */ get: operations["licenses/get"]; }; "/markdown": { @@ -1929,6 +1937,15 @@ export interface paths { */ get: operations["secret-scanning/list-alerts-for-org"]; }; + "/orgs/{org}/security-advisories": { + /** + * List repository security advisories for an organization + * @description Lists repository security advisories for an organization. + * + * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission. + */ + get: operations["security-advisories/list-org-repository-advisories"]; + }; "/orgs/{org}/security-managers": { /** * List security manager teams @@ -2117,14 +2134,14 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { /** * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ get: operations["reactions/list-for-team-discussion-comment-in-org"]; /** * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ @@ -2135,21 +2152,21 @@ export interface paths { * Delete team discussion comment reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ delete: operations["reactions/delete-for-team-discussion-comment"]; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { /** * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ get: operations["reactions/list-for-team-discussion-in-org"]; /** * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ @@ -2160,7 +2177,7 @@ export interface paths { * Delete team discussion reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ delete: operations["reactions/delete-for-team-discussion"]; }; @@ -2422,6 +2439,17 @@ export interface paths { * Get rate limit status for the authenticated user * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. * + * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/overview/api-versions)." + * * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; @@ -3548,7 +3576,7 @@ export interface paths { * Create a check suite * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. */ post: operations["checks/create-suite"]; }; @@ -3788,7 +3816,7 @@ export interface paths { "/repos/{owner}/{repo}/code-scanning/sarifs": { /** * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. + * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." * * There are two places where you can upload code scanning results. * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." @@ -3801,7 +3829,7 @@ export interface paths { * ``` *
* SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. - * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. + * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * * * | **SARIF data** | **Maximum values** | **Additional limits** | @@ -3969,7 +3997,7 @@ export interface paths { * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * - * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations). + * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). * * **Updating an existing collaborator's permission level** * @@ -4022,7 +4050,7 @@ export interface paths { "/repos/{owner}/{repo}/comments": { /** * List commit comments for a repository - * @description Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + * @description Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). * * Comments are ordered by ascending ID. */ @@ -4039,12 +4067,12 @@ export interface paths { "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { /** * List reactions for a commit comment - * @description List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + * @description List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ get: operations["reactions/list-for-commit-comment"]; /** * Create reaction for a commit comment - * @description Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. + * @description Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ post: operations["reactions/create-for-commit-comment"]; }; @@ -4053,7 +4081,7 @@ export interface paths { * Delete a commit comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ delete: operations["reactions/delete-for-commit-comment"]; }; @@ -4282,13 +4310,13 @@ export interface paths { * @description Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. * - * Files and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for + * Files and symlinks support [a custom media type](https://docs.github.com/rest/overview/media-types) for * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media - * type](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent + * type](https://docs.github.com/rest/overview/media-types) to ensure the content is returned in a consistent * object format. * * **Notes**: - * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees). + * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees * API](https://docs.github.com/rest/git/trees#get-a-tree). * * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. @@ -4322,7 +4350,7 @@ export interface paths { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ put: operations["repos/create-or-update-file-contents"]; /** @@ -4335,7 +4363,7 @@ export interface paths { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; }; @@ -4569,7 +4597,7 @@ export interface paths { * * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[Secrets](/rest/reference/actions#secrets)." + * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -4890,7 +4918,7 @@ export interface paths { "/repos/{owner}/{repo}/git/trees/{tree_sha}": { /** * Get a tree - * @description Returns a single tree using the SHA1 value for that tree. + * @description Returns a single tree using the SHA1 value or ref name for that tree. * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * @@ -4915,28 +4943,28 @@ export interface paths { "/repos/{owner}/{repo}/hooks/{hook_id}": { /** * Get a repository webhook - * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." + * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ get: operations["repos/get-webhook"]; /** Delete a repository webhook */ delete: operations["repos/delete-webhook"]; /** * Update a repository webhook - * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." + * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." */ patch: operations["repos/update-webhook"]; }; "/repos/{owner}/{repo}/hooks/{hook_id}/config": { /** * Get a webhook configuration for a repository - * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." + * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." * * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. */ get: operations["repos/get-webhook-config-for-repo"]; /** * Update a webhook configuration for a repository - * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." + * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." * * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. */ @@ -5190,12 +5218,12 @@ export interface paths { "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { /** * List reactions for an issue comment - * @description List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + * @description List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ get: operations["reactions/list-for-issue-comment"]; /** * Create reaction for an issue comment - * @description Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. + * @description Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ post: operations["reactions/create-for-issue-comment"]; }; @@ -5204,7 +5232,7 @@ export interface paths { * Delete an issue comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ delete: operations["reactions/delete-for-issue-comment"]; }; @@ -5341,12 +5369,12 @@ export interface paths { "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { /** * List reactions for an issue - * @description List the reactions to an [issue](https://docs.github.com/rest/reference/issues). + * @description List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ get: operations["reactions/list-for-issue"]; /** * Create reaction for an issue - * @description Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. + * @description Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ post: operations["reactions/create-for-issue"]; }; @@ -5355,7 +5383,7 @@ export interface paths { * Delete an issue reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * - * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). + * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ delete: operations["reactions/delete-for-issue"]; }; @@ -5420,18 +5448,6 @@ export interface paths { */ get: operations["repos/list-languages"]; }; - "/repos/{owner}/{repo}/lfs": { - /** - * Enable Git LFS for a repository - * @description Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. - */ - put: operations["repos/enable-lfs-for-repo"]; - /** - * Disable Git LFS for a repository - * @description Disables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. - */ - delete: operations["repos/disable-lfs-for-repo"]; - }; "/repos/{owner}/{repo}/license": { /** * Get the license for a repository @@ -5581,6 +5597,18 @@ export interface paths { */ get: operations["repos/get-pages-health-check"]; }; + "/repos/{owner}/{repo}/private-vulnerability-reporting": { + /** + * Enable private vulnerability reporting for a repository + * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." + */ + put: operations["repos/enable-private-vulnerability-reporting"]; + /** + * Disable private vulnerability reporting for a repository + * @description Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". + */ + delete: operations["repos/disable-private-vulnerability-reporting"]; + }; "/repos/{owner}/{repo}/projects": { /** * List repository projects @@ -5636,12 +5664,12 @@ export interface paths { "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + * @description List the reactions to a [pull request review comment](https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; /** * Create reaction for a pull request review comment - * @description Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. + * @description Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ post: operations["reactions/create-for-pull-request-review-comment"]; }; @@ -5650,7 +5678,7 @@ export interface paths { * Delete a pull request comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * - * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ delete: operations["reactions/delete-for-pull-request-comment"]; }; @@ -5661,7 +5689,7 @@ export interface paths { * * Lists details of a pull request by providing its number. * - * When you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. * @@ -5724,7 +5752,7 @@ export interface paths { "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { /** * List commits on a pull request - * @description Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. + * @description Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) endpoint. */ get: operations["pulls/list-commits"]; }; @@ -5776,7 +5804,7 @@ export interface paths { * Create a review for a pull request * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * - * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request)." + * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * * **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. * @@ -5811,14 +5839,14 @@ export interface paths { "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { /** * Dismiss a review for a pull request - * @description **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. + * @description **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ put: operations["pulls/dismiss-review"]; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { /** * Submit a review for a pull request - * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls#create-a-review-for-a-pull-request)." + * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." */ post: operations["pulls/submit-review"]; }; @@ -5834,7 +5862,7 @@ export interface paths { * Get a repository README * @description Gets the preferred README for a repository. * - * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. */ get: operations["repos/get-readme"]; }; @@ -5843,7 +5871,7 @@ export interface paths { * Get a repository README for a directory * @description Gets the README from a repository directory. * - * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. */ get: operations["repos/get-readme-in-directory"]; }; @@ -5880,7 +5908,7 @@ export interface paths { "/repos/{owner}/{repo}/releases/generate-notes": { /** * Generate release notes content for a release - * @description Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. + * @description Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ post: operations["repos/generate-release-notes"]; }; @@ -5937,7 +5965,7 @@ export interface paths { * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. * * **Notes:** - * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List assets for a release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)" + * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)" * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. @@ -5947,12 +5975,12 @@ export interface paths { "/repos/{owner}/{repo}/releases/{release_id}/reactions": { /** * List reactions for a release - * @description List the reactions to a [release](https://docs.github.com/rest/reference/repos#releases). + * @description List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ get: operations["reactions/list-for-release"]; /** * Create reaction for a release - * @description Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. + * @description Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ post: operations["reactions/create-for-release"]; }; @@ -5961,7 +5989,7 @@ export interface paths { * Delete a release reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * - * Delete a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). + * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ delete: operations["reactions/delete-for-release"]; }; @@ -6094,6 +6122,19 @@ export interface paths { */ patch: operations["security-advisories/update-repository-advisory"]; }; + "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": { + /** + * Request a CVE for a repository security advisory + * @description If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." + * + * You may request a CVE for public repositories, but cannot do so for private repositories. + * + * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + * + * In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + */ + post: operations["security-advisories/create-repository-advisory-cve-request"]; + }; "/repos/{owner}/{repo}/stargazers": { /** * List stargazers @@ -6450,7 +6491,7 @@ export interface paths { * Search code * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: * @@ -6477,7 +6518,7 @@ export interface paths { * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match - * metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: * @@ -6491,7 +6532,7 @@ export interface paths { * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. * @@ -6508,7 +6549,7 @@ export interface paths { * Search labels * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: * @@ -6523,7 +6564,7 @@ export interface paths { * Search repositories * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: * @@ -6538,7 +6579,7 @@ export interface paths { * Search topics * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: * @@ -6553,7 +6594,7 @@ export interface paths { * Search users * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you're looking for a list of popular users, you might try this query: * @@ -6691,7 +6732,7 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ get: operations["reactions/list-for-team-discussion-comment-legacy"]; /** @@ -6699,7 +6740,7 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. */ post: operations["reactions/create-for-team-discussion-comment-legacy"]; }; @@ -6709,7 +6750,7 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ get: operations["reactions/list-for-team-discussion-legacy"]; /** @@ -6717,7 +6758,7 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. */ post: operations["reactions/create-for-team-discussion-legacy"]; }; @@ -6878,7 +6919,7 @@ export interface paths { * @deprecated * @description **Note**: Repositories inherited through a parent team will also be checked. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-repository) endpoint. + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ @@ -6886,7 +6927,7 @@ export interface paths { /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. + * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -6896,7 +6937,7 @@ export interface paths { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. + * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -7684,7 +7725,7 @@ export interface paths { * * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". */ get: operations["users/get-by-username"]; }; @@ -7978,7 +8019,7 @@ export interface webhooks { /** * This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/rest/branches/branch-protection)" in the REST API documentation. * - * To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission + * To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. * @description A branch protection rule was created. */ post: operations["branch-protection-rule/created"]; @@ -8320,6 +8361,39 @@ export interface webhooks { */ post: operations["deployment-protection-rule/requested"]; }; + "deployment-review-approved": { + /** + * This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. + * + * For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + * @description A deployment review was approved. + */ + post: operations["deployment-review/approved"]; + }; + "deployment-review-rejected": { + /** + * This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. + * + * For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + * @description A deployment review was rejected. + */ + post: operations["deployment-review/rejected"]; + }; + "deployment-review-requested": { + /** + * This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. + * + * For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + * @description A deployment review was requested. + */ + post: operations["deployment-review/requested"]; + }; "deployment-status-created": { /** * This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. @@ -8596,7 +8670,7 @@ export interface webhooks { /** * This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. * - * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. * @description Someone installed a GitHub App on a user or organization account. */ post: operations["installation/created"]; @@ -8605,7 +8679,7 @@ export interface webhooks { /** * This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. * - * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. * @description Someone uninstalled a GitHub App from their user or organization account. */ post: operations["installation/deleted"]; @@ -8614,7 +8688,7 @@ export interface webhooks { /** * This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. * - * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. * @description Someone granted new permissions to a GitHub App. */ post: operations["installation/new-permissions-accepted"]; @@ -8623,7 +8697,7 @@ export interface webhooks { /** * This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. * - * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. * @description A GitHub App installation was granted access to one or more repositories. */ post: operations["installation-repositories/added"]; @@ -8632,7 +8706,7 @@ export interface webhooks { /** * This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. * - * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. * @description Access to one or more repositories was revoked for a GitHub App installation. */ post: operations["installation-repositories/removed"]; @@ -8641,14 +8715,14 @@ export interface webhooks { /** * This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. * - * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. * @description Someone blocked access by a GitHub App to their user or organization account. */ post: operations["installation/suspend"]; }; "installation-target-renamed": { /** - * This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + * This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. * @description Somebody renamed the user or organization account that a GitHub App is installed on. */ post: operations["installation-target/renamed"]; @@ -8657,7 +8731,7 @@ export interface webhooks { /** * This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. * - * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. * @description A GitHub App that was blocked from accessing a user or organization account was given access the account again. */ post: operations["installation/unsuspend"]; @@ -8977,7 +9051,7 @@ export interface webhooks { }; "membership-removed": { /** - * This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. + * This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. * @description An organization member was removed from a team. @@ -9697,7 +9771,7 @@ export interface webhooks { /** * This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. * - * For activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + * For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. * @description A previously closed pull request was reopened. @@ -9794,7 +9868,7 @@ export interface webhooks { }; "pull-request-review-thread-resolved": { /** - * This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request review comment threads, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + * This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. * * For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. * @@ -9860,7 +9934,7 @@ export interface webhooks { }; "push": { /** - * This event occurs when a commit or tag is pushed. + * This event occurs when a commit or tag is pushed, or when a repository is cloned. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * @@ -9885,7 +9959,7 @@ export interface webhooks { * * To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. * - * **Note**: GitHub recommends that you use the newer `package` event instead + * **Note**: GitHub recommends that you use the newer `package` event instead. * @description A package that was previously published to a registry was updated. */ post: operations["registry-package/updated"]; @@ -9901,7 +9975,7 @@ export interface webhooks { }; "release-deleted": { /** - * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * @description A release, pre-release, or draft release was deleted. @@ -9910,7 +9984,7 @@ export interface webhooks { }; "release-edited": { /** - * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * @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)." @@ -9919,7 +9993,7 @@ export interface webhooks { }; "release-prereleased": { /** - * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * @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. @@ -9928,7 +10002,7 @@ export interface webhooks { }; "release-published": { /** - * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * @description A release, pre-release, or draft of a release was published. @@ -9937,7 +10011,7 @@ export interface webhooks { }; "release-released": { /** - * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * @description A release was published, or a pre-release was changed to a release. @@ -9946,7 +10020,7 @@ export interface webhooks { }; "release-unpublished": { /** - * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * @description A release or pre-release was unpublished. @@ -10047,6 +10121,39 @@ export interface webhooks { */ post: operations["repository/renamed"]; }; + "repository-ruleset-created": { + /** + * This event occurs when there is activity relating to repository rulesets. + * For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + * For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + * @description A repository ruleset was created. + */ + post: operations["repository-ruleset/created"]; + }; + "repository-ruleset-deleted": { + /** + * This event occurs when there is activity relating to repository rulesets. + * For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + * For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + * @description A repository ruleset was deleted. + */ + post: operations["repository-ruleset/deleted"]; + }; + "repository-ruleset-edited": { + /** + * This event occurs when there is activity relating to repository rulesets. + * For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + * For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + * @description A repository ruleset was edited. + */ + post: operations["repository-ruleset/edited"]; + }; "repository-transferred": { /** * This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. @@ -10271,7 +10378,7 @@ export interface webhooks { }; "status": { /** - * This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Statuses](https://docs.github.com/rest/reference/commits#commit-statuses)" in the REST API documentation. + * This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. */ @@ -10392,13 +10499,11 @@ export interface webhooks { }; "workflow-job-waiting": { /** - * This event occurs when there is activity relating to a job in a GitHub Actions workflow. - * - * For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see [the REST API documentation](https://docs.github.com/rest/actions/workflow-jobs). + * This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. * - * For activity relating to a workflow run instead of a job in a workflow run, see the `workflow_run` event. + * For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. * - * To install this event on a GitHub App, the app must have at least read-level access for the Actions metadata permission. + * To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. * @description A job in a workflow run was created and is waiting for approvals. */ post: operations["workflow-job/waiting"]; @@ -10617,7 +10722,8 @@ export interface components { github_reviewed_at: string | null; /** * Format: date-time - * @description The date and time of when the advisory was published in the National Vulnerability Database, in ISO 8601 format. + * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. + * This field is only populated when the advisory is imported from the National Vulnerability Database. */ nvd_published_at: string | null; /** @@ -12535,6 +12641,7 @@ export interface components { }; ssh_keys?: string[]; hooks?: string[]; + github_enterprise_importer?: string[]; web?: string[]; api?: string[]; git?: string[]; @@ -14226,6 +14333,128 @@ export interface components { /** Format: date-time */ updated_at?: string; }; + /** @description A product affected by the vulnerability detailed in a repository security advisory. */ + "repository-advisory-vulnerability": { + /** @description The name of the package affected by the vulnerability. */ + package: ({ + ecosystem: components["schemas"]["security-advisory-ecosystems"]; + /** @description The unique package name within its ecosystem. */ + name: string | null; + }) | null; + /** @description The range of the package versions affected by the vulnerability. */ + vulnerable_version_range: string | null; + /** @description The package version(s) that resolve the vulnerability. */ + patched_versions: string | null; + /** @description The functions in the package that are affected. */ + vulnerable_functions: string[] | null; + }; + /** @description A credit given to a user for a repository security advisory. */ + "repository-advisory-credit": { + user: components["schemas"]["simple-user"]; + type: components["schemas"]["security-advisory-credit-types"]; + /** + * @description The state of the user's acceptance of the credit. + * @enum {string} + */ + state: "accepted" | "declined" | "pending"; + }; + /** @description A repository security advisory. */ + "repository-advisory": { + /** @description The GitHub Security Advisory ID. */ + ghsa_id: string; + /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + cve_id: string | null; + /** @description The API URL for the advisory. */ + url: string; + /** + * Format: uri + * @description The URL for the advisory. + */ + html_url: string; + /** @description A short summary of the advisory. */ + summary: string; + /** @description A detailed description of what the advisory entails. */ + description: string | null; + /** + * @description The severity of the advisory. + * @enum {string|null} + */ + severity: "critical" | "high" | "medium" | "low" | null; + /** @description The author of the advisory. */ + author: null; + /** @description The publisher of the advisory. */ + publisher: null; + identifiers: readonly ({ + /** + * @description The type of identifier. + * @enum {string} + */ + type: "CVE" | "GHSA"; + /** @description The identifier value. */ + value: string; + })[]; + /** + * @description The state of the advisory. + * @enum {string} + */ + state: "published" | "closed" | "withdrawn" | "draft" | "triage"; + /** + * Format: date-time + * @description The date and time of when the advisory was created, in ISO 8601 format. + */ + created_at: string | null; + /** + * Format: date-time + * @description The date and time of when the advisory was last updated, in ISO 8601 format. + */ + updated_at: string | null; + /** + * Format: date-time + * @description The date and time of when the advisory was published, in ISO 8601 format. + */ + published_at: string | null; + /** + * Format: date-time + * @description The date and time of when the advisory was closed, in ISO 8601 format. + */ + closed_at: string | null; + /** + * Format: date-time + * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + */ + withdrawn_at: string | null; + submission: { + /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ + readonly accepted: boolean; + } | null; + vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null; + cvss: ({ + /** @description The CVSS vector. */ + vector_string: string | null; + /** @description The CVSS score. */ + score: number | null; + }) | null; + cwes: readonly { + /** @description The Common Weakness Enumeration (CWE) identifier. */ + cwe_id: string; + /** @description The name of the CWE. */ + name: string; + }[] | null; + /** @description A list of only the CWE IDs. */ + cwe_ids: string[] | null; + credits: { + /** @description The username of the user credited. */ + login?: string; + type?: components["schemas"]["security-advisory-credit-types"]; + }[] | null; + credits_detailed: readonly components["schemas"]["repository-advisory-credit"][] | null; + /** @description A list of users that collaborate on the advisory. */ + collaborating_users: components["schemas"]["simple-user"][] | null; + /** @description A list of teams that collaborate on the advisory. */ + collaborating_teams: components["schemas"]["team"][] | null; + /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ + private_fork: null; + }; "actions-billing-usage": { /** @description The sum of the free and paid GitHub Actions minutes used. */ total_minutes_used: number; @@ -16236,6 +16465,11 @@ export interface components { * @description Timestamp of latest configuration update. */ updated_at?: string | null; + /** + * @description The frequency of the periodic analysis. + * @enum {string|null} + */ + schedule?: "weekly" | null; }; /** @description Configuration for code scanning default setup. */ "code-scanning-default-setup-update": { @@ -19221,128 +19455,6 @@ export interface components { type: "commit" | "issue_title" | "issue_body" | "issue_comment"; details: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"]; }; - /** @description A product affected by the vulnerability detailed in a repository security advisory. */ - "repository-advisory-vulnerability": { - /** @description The name of the package affected by the vulnerability. */ - package: ({ - ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ - name: string | null; - }) | null; - /** @description The range of the package versions affected by the vulnerability. */ - vulnerable_version_range: string | null; - /** @description The package version(s) that resolve the vulnerability. */ - patched_versions: string | null; - /** @description The functions in the package that are affected. */ - vulnerable_functions: string[] | null; - }; - /** @description A credit given to a user for a repository security advisory. */ - "repository-advisory-credit": { - user: components["schemas"]["simple-user"]; - type: components["schemas"]["security-advisory-credit-types"]; - /** - * @description The state of the user's acceptance of the credit. - * @enum {string} - */ - state: "accepted" | "declined" | "pending"; - }; - /** @description A repository security advisory. */ - "repository-advisory": { - /** @description The GitHub Security Advisory ID. */ - ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - cve_id: string | null; - /** @description The API URL for the advisory. */ - url: string; - /** - * Format: uri - * @description The URL for the advisory. - */ - html_url: string; - /** @description A short summary of the advisory. */ - summary: string; - /** @description A detailed description of what the advisory entails. */ - description: string | null; - /** - * @description The severity of the advisory. - * @enum {string|null} - */ - severity: "critical" | "high" | "medium" | "low" | null; - /** @description The author of the advisory. */ - author: null; - /** @description The publisher of the advisory. */ - publisher: null; - identifiers: readonly ({ - /** - * @description The type of identifier. - * @enum {string} - */ - type: "CVE" | "GHSA"; - /** @description The identifier value. */ - value: string; - })[]; - /** - * @description The state of the advisory. - * @enum {string} - */ - state: "published" | "closed" | "withdrawn" | "draft" | "triage"; - /** - * Format: date-time - * @description The date and time of when the advisory was created, in ISO 8601 format. - */ - created_at: string | null; - /** - * Format: date-time - * @description The date and time of when the advisory was last updated, in ISO 8601 format. - */ - updated_at: string | null; - /** - * Format: date-time - * @description The date and time of when the advisory was published, in ISO 8601 format. - */ - published_at: string | null; - /** - * Format: date-time - * @description The date and time of when the advisory was closed, in ISO 8601 format. - */ - closed_at: string | null; - /** - * Format: date-time - * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. - */ - withdrawn_at: string | null; - submission: { - /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ - readonly accepted: boolean; - } | null; - vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null; - cvss: ({ - /** @description The CVSS vector. */ - vector_string: string | null; - /** @description The CVSS score. */ - score: number | null; - }) | null; - cwes: readonly { - /** @description The Common Weakness Enumeration (CWE) identifier. */ - cwe_id: string; - /** @description The name of the CWE. */ - name: string; - }[] | null; - /** @description A list of only the CWE IDs. */ - cwe_ids: string[] | null; - credits: { - /** @description The username of the user credited. */ - login?: string; - type?: components["schemas"]["security-advisory-credit-types"]; - }[] | null; - credits_detailed: readonly components["schemas"]["repository-advisory-credit"][] | null; - /** @description A list of users that collaborate on the advisory. */ - collaborating_users: components["schemas"]["simple-user"][] | null; - /** @description A list of teams that collaborate on the advisory. */ - collaborating_teams: components["schemas"]["team"][] | null; - /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ - private_fork: null; - }; "repository-advisory-create": { /** @description A short summary of the advisory. */ summary: string; @@ -21007,7 +21119,7 @@ export interface components { "webhook-check-suite-completed": { /** @enum {string} */ action: "completed"; - /** @description The [check_suite](https://docs.github.com/rest/reference/checks#suites). */ + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { after: string | null; /** @@ -21248,7 +21360,7 @@ export interface components { "webhook-check-suite-requested": { /** @enum {string} */ action: "requested"; - /** @description The [check_suite](https://docs.github.com/rest/reference/checks#suites). */ + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { after: string | null; /** @@ -21489,7 +21601,7 @@ export interface components { "webhook-check-suite-rerequested": { /** @enum {string} */ action: "rerequested"; - /** @description The [check_suite](https://docs.github.com/rest/reference/checks#suites). */ + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { after: string | null; /** @@ -22409,7 +22521,7 @@ export interface components { * @enum {string} */ action: "created"; - /** @description The [commit comment](https://docs.github.com/rest/reference/repos#get-a-commit-comment) resource. */ + /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ comment: { /** * AuthorAssociation @@ -22616,7 +22728,7 @@ export interface components { action: "created"; enterprise?: components["schemas"]["enterprise"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [`deploy key`](https://docs.github.com/rest/reference/deployments#get-a-deploy-key) resource. */ + /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ key: { added_by?: string | null; created_at: string; @@ -22639,7 +22751,7 @@ export interface components { action: "deleted"; enterprise?: components["schemas"]["enterprise"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [`deploy key`](https://docs.github.com/rest/reference/deployments#get-a-deploy-key) resource. */ + /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ key: { added_by?: string | null; created_at: string; @@ -22662,7 +22774,7 @@ export interface components { action: "created"; /** * Deployment - * @description The [deployment](https://docs.github.com/rest/reference/deployments#list-deployments). + * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). */ deployment: { created_at: string; @@ -23180,6 +23292,1129 @@ export interface components { installation?: components["schemas"]["simple-installation"]; sender?: components["schemas"]["simple-user"]; }; + "webhook-deployment-review-approved": { + /** @enum {string} */ + action: "approved"; + approver?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + comment?: string; + enterprise?: components["schemas"]["enterprise"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple"]; + repository: components["schemas"]["repository"]; + reviewers?: ({ + /** User */ + reviewer?: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + /** @enum {string} */ + type?: "User"; + })[]; + sender: components["schemas"]["simple-user"]; + since: string; + workflow_job_run?: { + conclusion: null; + created_at: string; + environment: string; + html_url: string; + id: number; + name: null; + status: string; + updated_at: string; + }; + workflow_job_runs?: ({ + conclusion?: null; + created_at?: string; + environment?: string; + html_url?: string; + id?: number; + name?: string | null; + status?: string; + updated_at?: string; + })[]; + /** Deployment Workflow Run */ + workflow_run: ({ + /** User */ + actor: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; + /** @enum {string|null} */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + created_at: string; + display_title: string; + event: string; + head_branch: string; + head_commit?: Record | null; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + id: number; + number: number; + /** Format: uri */ + url: string; + }[]; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; + }[] | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; + /** Format: date-time */ + run_started_at: string; + /** @enum {string} */ + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + /** User */ + triggering_actor: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + workflow_id: number; + workflow_url?: string; + }) | null; + }; + "webhook-deployment-review-rejected": { + /** @enum {string} */ + action: "rejected"; + approver?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + comment?: string; + enterprise?: components["schemas"]["enterprise"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple"]; + repository: components["schemas"]["repository"]; + reviewers?: ({ + /** User */ + reviewer?: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + /** @enum {string} */ + type?: "User"; + })[]; + sender: components["schemas"]["simple-user"]; + since: string; + workflow_job_run?: { + conclusion: null; + created_at: string; + environment: string; + html_url: string; + id: number; + name: null; + status: string; + updated_at: string; + }; + workflow_job_runs?: ({ + conclusion?: string | null; + created_at?: string; + environment?: string; + html_url?: string; + id?: number; + name?: string | null; + status?: string; + updated_at?: string; + })[]; + /** Deployment Workflow Run */ + workflow_run: ({ + /** User */ + actor: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; + /** @enum {string|null} */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + created_at: string; + event: string; + head_branch: string; + head_commit?: Record | null; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + id: number; + number: number; + /** Format: uri */ + url: string; + }[]; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; + }[] | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; + /** Format: date-time */ + run_started_at: string; + /** @enum {string} */ + status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; + /** User */ + triggering_actor: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + workflow_id: number; + workflow_url?: string; + display_title: string; + }) | null; + }; + "webhook-deployment-review-requested": { + /** @enum {string} */ + action: "requested"; + enterprise?: components["schemas"]["enterprise"]; + environment: string; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple"]; + repository: components["schemas"]["repository"]; + /** User */ + requestor: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + reviewers: ({ + /** User */ + reviewer?: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login?: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + /** @enum {string} */ + type?: "User" | "Team"; + })[]; + sender: components["schemas"]["simple-user"]; + since: string; + workflow_job_run: { + conclusion: null; + created_at: string; + environment: string; + html_url: string; + id: number; + name: string | null; + status: string; + updated_at: string; + }; + /** Deployment Workflow Run */ + workflow_run: ({ + /** User */ + actor: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; + /** @enum {string|null} */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + created_at: string; + event: string; + head_branch: string; + head_commit?: Record | null; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + id: number; + number: number; + /** Format: uri */ + url: string; + }[]; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; + }[] | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; + /** Format: date-time */ + run_started_at: string; + /** @enum {string} */ + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + /** User */ + triggering_actor: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + workflow_id: number; + workflow_url?: string; + display_title: string; + }) | null; + }; /** deployment_status created event */ "webhook-deployment-status-created": { /** @enum {string} */ @@ -23216,7 +24451,7 @@ export interface components { }) | null; /** * Deployment - * @description The [deployment](https://docs.github.com/rest/reference/deployments#list-deployments). + * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). */ deployment: { created_at: string; @@ -23410,7 +24645,7 @@ export interface components { /** Format: uri */ url: string; }; - /** @description The [deployment status](https://docs.github.com/rest/reference/deployments#list-deployment-statuses). */ + /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ deployment_status: { created_at: string; /** User */ @@ -25405,7 +26640,8 @@ export interface components { url?: string; website_url?: null; }; - action: string; + /** @enum {string} */ + action: "renamed"; changes: { login?: { from: string; @@ -25449,7 +26685,7 @@ export interface components { action: "created"; /** * issue comment - * @description The [comment](https://docs.github.com/rest/reference/issues#comments) itself. + * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. */ comment: { /** @@ -25534,7 +26770,7 @@ export interface components { }; enterprise?: components["schemas"]["enterprise"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/reference/issues) the comment belongs to. */ + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: ({ /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -26063,7 +27299,7 @@ export interface components { action: "deleted"; /** * issue comment - * @description The [comment](https://docs.github.com/rest/reference/issues#comments) itself. + * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. */ comment: { /** @@ -26148,7 +27384,7 @@ export interface components { }; enterprise?: components["schemas"]["enterprise"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/reference/issues) the comment belongs to. */ + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: ({ /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -26684,7 +27920,7 @@ export interface components { }; /** * issue comment - * @description The [comment](https://docs.github.com/rest/reference/issues#comments) itself. + * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. */ comment: { /** @@ -26769,7 +28005,7 @@ export interface components { }; enterprise?: components["schemas"]["enterprise"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/reference/issues) the comment belongs to. */ + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: ({ /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -27340,7 +28576,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -27761,7 +28997,7 @@ export interface components { action: "closed"; enterprise?: components["schemas"]["enterprise"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/reference/issues) itself. */ + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: ({ /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -28239,7 +29475,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -29285,7 +30521,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -29721,7 +30957,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -31247,7 +32483,7 @@ export interface components { changes?: { /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ old_issue: ({ /** @enum {string|null} */ @@ -31895,7 +33131,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -32315,7 +33551,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -33209,7 +34445,7 @@ export interface components { changes: { /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ new_issue: { /** @enum {string|null} */ @@ -33864,7 +35100,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -34324,7 +35560,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -34744,7 +35980,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -35655,7 +36891,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -38428,7 +39664,7 @@ export interface components { }; /** page_build event */ "webhook-page-build": { - /** @description The [List GitHub Pages builds](https://docs.github.com/rest/reference/repos#list-github-pages-builds) itself. */ + /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ build: { commit: string | null; created_at: string; @@ -50789,7 +52025,7 @@ export interface components { action: "created"; /** * Pull Request Review Comment - * @description The [comment](https://docs.github.com/rest/reference/pulls#comments) itself. + * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ comment: { _links: { @@ -52061,7 +53297,7 @@ export interface components { action: "deleted"; /** * Pull Request Review Comment - * @description The [comment](https://docs.github.com/rest/reference/pulls#comments) itself. + * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ comment: { _links: { @@ -53340,7 +54576,7 @@ export interface components { }; /** * Pull Request Review Comment - * @description The [comment](https://docs.github.com/rest/reference/pulls#comments) itself. + * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ comment: { _links: { @@ -70242,7 +71478,7 @@ export interface components { base_ref: string | null; /** @description The SHA of the most recent commit on `ref` before the push. */ before: string; - /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/reference/repos#commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. */ + /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. */ commits: ({ /** @description An array of files added in the commit. */ added?: string[]; @@ -70811,7 +72047,8 @@ export interface components { sender: components["schemas"]["simple-user"]; }; "webhook-registry-package-updated": { - action: string; + /** @enum {string} */ + action: "updated"; enterprise?: components["schemas"]["enterprise"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple"]; @@ -70951,7 +72188,7 @@ export interface components { organization?: components["schemas"]["organization-simple"]; /** * Release - * @description The [release](https://docs.github.com/rest/reference/repos/#get-a-release) object. + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ release: { assets: ({ @@ -71108,7 +72345,7 @@ export interface components { organization?: components["schemas"]["organization-simple"]; /** * Release - * @description The [release](https://docs.github.com/rest/reference/repos/#get-a-release) object. + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ release: { assets: ({ @@ -71279,7 +72516,7 @@ export interface components { organization?: components["schemas"]["organization-simple"]; /** * Release - * @description The [release](https://docs.github.com/rest/reference/repos/#get-a-release) object. + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ release: { assets: ({ @@ -71823,7 +73060,7 @@ export interface components { organization?: components["schemas"]["organization-simple"]; /** * Release - * @description The [release](https://docs.github.com/rest/reference/repos/#get-a-release) object. + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ release: { assets: ({ @@ -72216,7 +73453,8 @@ export interface components { }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { - action: string; + /** @enum {string} */ + action: "sample.collected"; branch: string; client_payload: { [key: string]: unknown; @@ -72298,6 +73536,86 @@ export interface components { repository: components["schemas"]["repository"]; sender: components["schemas"]["simple-user"]; }; + /** repository ruleset created event */ + "webhook-repository-ruleset-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple"]; + repository?: components["schemas"]["repository"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + sender: components["schemas"]["simple-user"]; + }; + /** repository ruleset deleted event */ + "webhook-repository-ruleset-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple"]; + repository?: components["schemas"]["repository"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + sender: components["schemas"]["simple-user"]; + }; + /** repository ruleset edited event */ + "webhook-repository-ruleset-edited": { + /** @enum {string} */ + action: "edited"; + enterprise?: components["schemas"]["enterprise"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple"]; + repository?: components["schemas"]["repository"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + changes?: { + name?: { + from?: string; + }; + enforcement?: { + from?: string; + }; + conditions?: { + added?: components["schemas"]["repository-ruleset-conditions"][]; + deleted?: components["schemas"]["repository-ruleset-conditions"][]; + updated?: { + condition?: components["schemas"]["repository-ruleset-conditions"]; + changes?: { + condition_type?: { + from?: string; + }; + target?: { + from?: string; + }; + include?: { + from?: string[]; + }; + exclude?: { + from?: string[]; + }; + }; + }[]; + }; + rules?: { + added?: components["schemas"]["repository-rule"][]; + deleted?: components["schemas"]["repository-rule"][]; + updated?: { + rule?: components["schemas"]["repository-rule"]; + changes?: { + configuration?: { + from?: string; + }; + rule_type?: { + from?: string; + }; + pattern?: { + from?: string; + }; + }; + }[]; + }; + }; + sender: components["schemas"]["simple-user"]; + }; /** repository transferred event */ "webhook-repository-transferred": { /** @enum {string} */ @@ -78285,7 +79603,9 @@ export interface operations { }; /** * List global security advisories - * @description List global security advisories and filter using parameters such as ecosystem, GHSA ID, CVE ID, etc. + * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. + * + * 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: { @@ -78300,11 +79620,20 @@ export interface operations { ecosystem?: "actions" | "composer" | "erlang" | "go" | "maven" | "npm" | "nuget" | "other" | "pip" | "pub" | "rubygems" | "rust"; /** @description If specified, only advisories with these severities will be returned. */ severity?: "unknown" | "low" | "medium" | "high" | "critical"; - /** @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. */ + /** + * @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. + * + * Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` + */ cwes?: string | string[]; /** @description Whether to only return advisories that have been withdrawn. */ is_withdrawn?: boolean; - /** @description If specified, return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. */ + /** + * @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. + * If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. + * + * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` + */ affects?: string | string[]; /** * @description If specified, only return advisories that were published on a date or date range. @@ -78593,7 +79922,7 @@ export interface operations { }; /** * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. + * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. * * 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. */ @@ -79585,7 +80914,7 @@ export interface operations { * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app)" endpoint. + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. * * 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. */ @@ -79644,7 +80973,10 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Get all commonly used licenses */ + /** + * Get all commonly used licenses + * @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: { query?: { @@ -79663,7 +80995,10 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** Get a license */ + /** + * Get a license + * @description Gets information about a specific license. 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": { parameters: { path: { @@ -82814,7 +84149,7 @@ export interface operations { "application/json": { /** @description Must be passed as "web". */ name: string; - /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#create-hook-config-params). */ + /** @description Key/value pairs to provide settings for this webhook. */ config: { url: components["schemas"]["webhook-config-url"]; content_type?: components["schemas"]["webhook-config-content-type"]; @@ -82904,7 +84239,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#update-hook-config-params). */ + /** @description Key/value pairs to provide settings for this webhook. */ config?: { url: components["schemas"]["webhook-config-url"]; content_type?: components["schemas"]["webhook-config-content-type"]; @@ -85003,6 +86338,40 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * List repository security advisories for an organization + * @description Lists repository security advisories for an organization. + * + * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission. + */ + "security-advisories/list-org-repository-advisories": { + parameters: { + query?: { + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: "created" | "updated" | "published"; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + /** @description The number of advisories to return per page. */ + per_page?: number; + /** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */ + state?: "triage" | "draft" | "published" | "closed"; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-advisory"][]; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List security manager teams * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." @@ -85638,14 +87007,14 @@ export interface operations { }; /** * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ "reactions/list-for-team-discussion-comment-in-org": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -85671,7 +87040,7 @@ export interface operations { }; /** * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ @@ -85688,7 +87057,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. * @enum {string} */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; @@ -85714,7 +87083,7 @@ export interface operations { * Delete team discussion comment reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ "reactions/delete-for-team-discussion-comment": { parameters: { @@ -85735,14 +87104,14 @@ export interface operations { }; /** * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ "reactions/list-for-team-discussion-in-org": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -85767,7 +87136,7 @@ export interface operations { }; /** * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ @@ -85783,7 +87152,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. * @enum {string} */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; @@ -85809,7 +87178,7 @@ export interface operations { * Delete team discussion reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ "reactions/delete-for-team-discussion": { parameters: { @@ -86924,6 +88293,17 @@ export interface operations { * Get rate limit status for the authenticated user * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. * + * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/overview/api-versions)." + * * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ "rate-limit/get": { @@ -90667,7 +92047,7 @@ export interface operations { caption?: string; }[]; }; - /** @description Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ + /** @description Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ actions?: { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ label: string; @@ -90805,7 +92185,7 @@ export interface operations { caption?: string; }[]; }; - /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ + /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ actions?: { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ label: string; @@ -90904,7 +92284,7 @@ export interface operations { * Create a check suite * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. */ "checks/create-suite": { parameters: { @@ -91511,7 +92891,7 @@ export interface operations { }; /** * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. + * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." * * There are two places where you can upload code scanning results. * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." @@ -91524,7 +92904,7 @@ export interface operations { * ``` *
* SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. - * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. + * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * * * | **SARIF data** | **Maximum values** | **Additional limits** | @@ -92087,7 +93467,7 @@ export interface operations { * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * - * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations). + * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). * * **Updating an existing collaborator's permission level** * @@ -92207,7 +93587,7 @@ export interface operations { }; /** * List commit comments for a repository - * @description Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + * @description Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). * * Comments are ordered by ascending ID. */ @@ -92299,12 +93679,12 @@ export interface operations { }; /** * List reactions for a commit comment - * @description List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + * @description List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ "reactions/list-for-commit-comment": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -92330,7 +93710,7 @@ export interface operations { }; /** * Create reaction for a commit comment - * @description Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. + * @description Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ "reactions/create-for-commit-comment": { parameters: { @@ -92344,7 +93724,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the commit comment. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment. * @enum {string} */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; @@ -92371,7 +93751,7 @@ export interface operations { * Delete a commit comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ "reactions/delete-for-commit-comment": { parameters: { @@ -92898,13 +94278,13 @@ export interface operations { * @description Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. * - * Files and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for + * Files and symlinks support [a custom media type](https://docs.github.com/rest/overview/media-types) for * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media - * type](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent + * type](https://docs.github.com/rest/overview/media-types) to ensure the content is returned in a consistent * object format. * * **Notes**: - * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees). + * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees * API](https://docs.github.com/rest/git/trees#get-a-tree). * * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. @@ -92963,7 +94343,7 @@ export interface operations { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ "repos/create-or-update-file-contents": { parameters: { @@ -93032,7 +94412,7 @@ export interface operations { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ "repos/delete-file": { parameters: { @@ -93885,7 +95265,7 @@ export interface operations { * * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[Secrets](/rest/reference/actions#secrets)." + * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -94640,8 +96020,8 @@ export interface operations { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; /** - * @description The name of the fully qualified reference to update. For example, `refs/heads/master`. If the value doesn't start with `refs` and have at least two slashes, it will be rejected. - * @example refs/head/master + * @description The name of the reference to update (for example, `heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/featureA */ ref: string; }; @@ -94872,7 +96252,7 @@ export interface operations { }; /** * Get a tree - * @description Returns a single tree using the SHA1 value for that tree. + * @description Returns a single tree using the SHA1 value or ref name for that tree. * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * @@ -94888,6 +96268,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; + /** @description The SHA1 value or ref (branch or tag) name of the tree. */ tree_sha: string; }; }; @@ -94947,7 +96328,7 @@ export interface operations { "application/json": { /** @description Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. */ name?: string; - /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */ + /** @description Key/value pairs to provide settings for this webhook. */ config?: { url?: components["schemas"]["webhook-config-url"]; content_type?: components["schemas"]["webhook-config-content-type"]; @@ -94989,7 +96370,7 @@ export interface operations { }; /** * Get a repository webhook - * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." + * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ "repos/get-webhook": { parameters: { @@ -95028,7 +96409,7 @@ export interface operations { }; /** * Update a repository webhook - * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." + * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." */ "repos/update-webhook": { parameters: { @@ -95041,7 +96422,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */ + /** @description Key/value pairs to provide settings for this webhook. */ config?: { url: components["schemas"]["webhook-config-url"]; content_type?: components["schemas"]["webhook-config-content-type"]; @@ -95082,7 +96463,7 @@ export interface operations { }; /** * Get a webhook configuration for a repository - * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." + * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." * * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. */ @@ -95105,7 +96486,7 @@ export interface operations { }; /** * Update a webhook configuration for a repository - * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." + * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." * * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. */ @@ -95940,12 +97321,12 @@ export interface operations { }; /** * List reactions for an issue comment - * @description List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + * @description List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ "reactions/list-for-issue-comment": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -95971,7 +97352,7 @@ export interface operations { }; /** * Create reaction for an issue comment - * @description Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. + * @description Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ "reactions/create-for-issue-comment": { parameters: { @@ -95985,7 +97366,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue comment. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment. * @enum {string} */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; @@ -96012,7 +97393,7 @@ export interface operations { * Delete an issue comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ "reactions/delete-for-issue-comment": { parameters: { @@ -96589,12 +97970,12 @@ export interface operations { }; /** * List reactions for an issue - * @description List the reactions to an [issue](https://docs.github.com/rest/reference/issues). + * @description List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ "reactions/list-for-issue": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -96621,7 +98002,7 @@ export interface operations { }; /** * Create reaction for an issue - * @description Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. + * @description Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ "reactions/create-for-issue": { parameters: { @@ -96635,7 +98016,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue. * @enum {string} */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; @@ -96662,7 +98043,7 @@ export interface operations { * Delete an issue reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * - * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). + * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ "reactions/delete-for-issue": { parameters: { @@ -96973,49 +98354,6 @@ export interface operations { }; }; }; - /** - * Enable Git LFS for a repository - * @description Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. - */ - "repos/enable-lfs-for-repo": { - parameters: { - path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; - responses: { - 202: components["responses"]["accepted"]; - /** - * @description We will return a 403 with one of the following messages: - * - * - Git LFS support not enabled because Git LFS is globally disabled. - * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. - * - Git LFS support not enabled because Git LFS is disabled for . - */ - 403: { - content: never; - }; - }; - }; - /** - * Disable Git LFS for a repository - * @description Disables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. - */ - "repos/disable-lfs-for-repo": { - parameters: { - path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - }; - }; /** * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. @@ -97695,6 +99033,38 @@ export interface operations { }; }; }; + /** + * Enable private vulnerability reporting for a repository + * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." + */ + "repos/enable-private-vulnerability-reporting": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 422: components["responses"]["bad_request"]; + }; + }; + /** + * Disable private vulnerability reporting for a repository + * @description Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". + */ + "repos/disable-private-vulnerability-reporting": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 422: components["responses"]["bad_request"]; + }; + }; /** * List repository projects * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. @@ -97965,12 +99335,12 @@ export interface operations { }; /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + * @description List the reactions to a [pull request review comment](https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request). */ "reactions/list-for-pull-request-review-comment": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -97996,7 +99366,7 @@ export interface operations { }; /** * Create reaction for a pull request review comment - * @description Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. + * @description Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ "reactions/create-for-pull-request-review-comment": { parameters: { @@ -98010,7 +99380,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the pull request review comment. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment. * @enum {string} */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; @@ -98037,7 +99407,7 @@ export interface operations { * Delete a pull request comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * - * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ "reactions/delete-for-pull-request-comment": { parameters: { @@ -98061,7 +99431,7 @@ export interface operations { * * Lists details of a pull request by providing its number. * - * When you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. * @@ -98345,7 +99715,7 @@ export interface operations { }; /** * List commits on a pull request - * @description Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. + * @description Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) endpoint. */ "pulls/list-commits": { parameters: { @@ -98610,7 +99980,7 @@ export interface operations { * Create a review for a pull request * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * - * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request)." + * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * * **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. * @@ -98632,7 +100002,7 @@ export interface operations { /** @description **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. */ body?: string; /** - * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request) when you are ready. + * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready. * @enum {string} */ event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; @@ -98773,7 +100143,7 @@ export interface operations { }; /** * Dismiss a review for a pull request - * @description **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. + * @description **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ "pulls/dismiss-review": { parameters: { @@ -98807,7 +100177,7 @@ export interface operations { }; /** * Submit a review for a pull request - * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls#create-a-review-for-a-pull-request)." + * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." */ "pulls/submit-review": { parameters: { @@ -98858,7 +100228,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/reference/repos#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ + /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ expected_head_sha?: string; } | null; }; @@ -98881,7 +100251,7 @@ export interface operations { * Get a repository README * @description Gets the preferred README for a repository. * - * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. */ "repos/get-readme": { parameters: { @@ -98909,7 +100279,7 @@ export interface operations { * Get a repository README for a directory * @description Gets the README from a repository directory. * - * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. */ "repos/get-readme-in-directory": { parameters: { @@ -99108,7 +100478,7 @@ export interface operations { }; /** * Generate release notes content for a release - * @description Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. + * @description Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ "repos/generate-release-notes": { parameters: { @@ -99325,7 +100695,7 @@ export interface operations { * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. * * **Notes:** - * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List assets for a release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)" + * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)" * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. @@ -99362,12 +100732,12 @@ export interface operations { }; /** * List reactions for a release - * @description List the reactions to a [release](https://docs.github.com/rest/reference/repos#releases). + * @description List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ "reactions/list-for-release": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a release. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -99393,7 +100763,7 @@ export interface operations { }; /** * Create reaction for a release - * @description Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. + * @description Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ "reactions/create-for-release": { parameters: { @@ -99407,7 +100777,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the release. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release. * @enum {string} */ content: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; @@ -99434,7 +100804,7 @@ export interface operations { * Delete a release reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * - * Delete a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). + * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ "reactions/delete-for-release": { parameters: { @@ -99962,6 +101332,32 @@ export interface operations { }; }; }; + /** + * Request a CVE for a repository security advisory + * @description If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." + * + * You may request a CVE for public repositories, but cannot do so for private repositories. + * + * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + * + * In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + */ + "security-advisories/create-repository-advisory-cve-request": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + ghsa_id: components["parameters"]["ghsa_id"]; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** * List stargazers * @description Lists the people that have starred the repository. @@ -101078,7 +102474,7 @@ export interface operations { * Search code * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: * @@ -101100,11 +102496,11 @@ export interface operations { "search/code": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. */ q: string; /** * @deprecated - * @description **This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) + * @description **This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "indexed"; /** @@ -101138,7 +102534,7 @@ export interface operations { * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match - * metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: * @@ -101147,9 +102543,9 @@ export interface operations { "search/commits": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ + /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "author-date" | "committer-date"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -101175,7 +102571,7 @@ export interface operations { * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. * @@ -101188,9 +102584,9 @@ export interface operations { "search/issues-and-pull-requests": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ + /** @description Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -101218,7 +102614,7 @@ export interface operations { * Search labels * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: * @@ -101231,9 +102627,9 @@ export interface operations { query: { /** @description The id of the repository. */ repository_id: number; - /** @description The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */ + /** @description The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). */ q: string; - /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ + /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "created" | "updated"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -101261,7 +102657,7 @@ export interface operations { * Search repositories * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: * @@ -101272,9 +102668,9 @@ export interface operations { "search/repos": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ + /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -101301,7 +102697,7 @@ export interface operations { * Search topics * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: * @@ -101312,7 +102708,7 @@ export interface operations { "search/topics": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). */ q: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -101336,7 +102732,7 @@ export interface operations { * Search users * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you're looking for a list of popular users, you might try this query: * @@ -101349,9 +102745,9 @@ export interface operations { "search/users": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ + /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "followers" | "repositories" | "joined"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -101780,12 +103176,12 @@ export interface operations { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ "reactions/list-for-team-discussion-comment-legacy": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -101813,7 +103209,7 @@ export interface operations { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. */ "reactions/create-for-team-discussion-comment-legacy": { parameters: { @@ -101827,7 +103223,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. * @enum {string} */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; @@ -101848,12 +103244,12 @@ export interface operations { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ "reactions/list-for-team-discussion-legacy": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -101880,7 +103276,7 @@ export interface operations { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. */ "reactions/create-for-team-discussion-legacy": { parameters: { @@ -101893,7 +103289,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. * @enum {string} */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; @@ -102334,7 +103730,7 @@ export interface operations { * @deprecated * @description **Note**: Repositories inherited through a parent team will also be checked. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-repository) endpoint. + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ @@ -102366,7 +103762,7 @@ export interface operations { /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. + * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -102403,7 +103799,7 @@ export interface operations { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. + * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -102814,7 +104210,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user) endpoint. */ + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -105175,7 +106571,7 @@ export interface operations { * * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". */ "users/get-by-username": { parameters: { @@ -106043,7 +107439,7 @@ export interface operations { /** @description Response */ 200: { content: { - "text/plain": string; + "application/json": string; }; }; }; @@ -106051,7 +107447,7 @@ export interface operations { /** * This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/rest/branches/branch-protection)" in the REST API documentation. * - * To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission + * To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. * @description A branch protection rule was created. */ "branch-protection-rule/created": { @@ -107238,6 +108634,123 @@ export interface operations { }; }; }; + /** + * This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. + * + * For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + * @description A deployment review was approved. + */ + "deployment-review/approved": { + parameters: { + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example issues */ + "X-Github-Event"?: string; + /** @example 123123 */ + "X-Github-Hook-Installation-Target-Id"?: string; + /** @example repository */ + "X-Github-Hook-Installation-Target-Type"?: string; + /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ + "X-GitHub-Delivery"?: string; + /** @example sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e */ + "X-Hub-Signature-256"?: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-deployment-review-approved"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + content: never; + }; + }; + }; + /** + * This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. + * + * For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + * @description A deployment review was rejected. + */ + "deployment-review/rejected": { + parameters: { + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example issues */ + "X-Github-Event"?: string; + /** @example 123123 */ + "X-Github-Hook-Installation-Target-Id"?: string; + /** @example repository */ + "X-Github-Hook-Installation-Target-Type"?: string; + /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ + "X-GitHub-Delivery"?: string; + /** @example sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e */ + "X-Hub-Signature-256"?: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-deployment-review-rejected"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + content: never; + }; + }; + }; + /** + * This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. + * + * For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + * @description A deployment review was requested. + */ + "deployment-review/requested": { + parameters: { + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example issues */ + "X-Github-Event"?: string; + /** @example 123123 */ + "X-Github-Hook-Installation-Target-Id"?: string; + /** @example repository */ + "X-Github-Hook-Installation-Target-Type"?: string; + /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ + "X-GitHub-Delivery"?: string; + /** @example sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e */ + "X-Hub-Signature-256"?: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-deployment-review-requested"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + content: never; + }; + }; + }; /** * This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. * @@ -108129,7 +109642,7 @@ export interface operations { /** * This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. * - * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. * @description Someone installed a GitHub App on a user or organization account. */ "installation/created": { @@ -108166,7 +109679,7 @@ export interface operations { /** * This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. * - * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. * @description Someone uninstalled a GitHub App from their user or organization account. */ "installation/deleted": { @@ -108203,7 +109716,7 @@ export interface operations { /** * This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. * - * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. * @description Someone granted new permissions to a GitHub App. */ "installation/new-permissions-accepted": { @@ -108240,7 +109753,7 @@ export interface operations { /** * This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. * - * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. * @description A GitHub App installation was granted access to one or more repositories. */ "installation-repositories/added": { @@ -108277,7 +109790,7 @@ export interface operations { /** * This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. * - * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. * @description Access to one or more repositories was revoked for a GitHub App installation. */ "installation-repositories/removed": { @@ -108314,7 +109827,7 @@ export interface operations { /** * This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. * - * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. * @description Someone blocked access by a GitHub App to their user or organization account. */ "installation/suspend": { @@ -108349,7 +109862,7 @@ export interface operations { }; }; /** - * This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + * This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. * @description Somebody renamed the user or organization account that a GitHub App is installed on. */ "installation-target/renamed": { @@ -108386,7 +109899,7 @@ export interface operations { /** * This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. * - * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + * For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. * @description A GitHub App that was blocked from accessing a user or organization account was given access the account again. */ "installation/unsuspend": { @@ -109602,7 +111115,7 @@ export interface operations { }; }; /** - * This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. + * This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. * @description An organization member was removed from a team. @@ -112143,7 +113656,7 @@ export interface operations { /** * This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. * - * For activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + * For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. * @description A previously closed pull request was reopened. @@ -112492,7 +114005,7 @@ export interface operations { }; }; /** - * This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request review comment threads, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + * This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. * * For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. * @@ -112726,7 +114239,7 @@ export interface operations { }; }; /** - * This event occurs when a commit or tag is pushed. + * This event occurs when a commit or tag is pushed, or when a repository is cloned. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * @@ -112807,7 +114320,7 @@ export interface operations { * * To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. * - * **Note**: GitHub recommends that you use the newer `package` event instead + * **Note**: GitHub recommends that you use the newer `package` event instead. * @description A package that was previously published to a registry was updated. */ "registry-package/updated": { @@ -112879,7 +114392,7 @@ export interface operations { }; }; /** - * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * @description A release, pre-release, or draft release was deleted. @@ -112916,7 +114429,7 @@ export interface operations { }; }; /** - * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * @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)." @@ -112953,7 +114466,7 @@ export interface operations { }; }; /** - * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * @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. @@ -112990,7 +114503,7 @@ export interface operations { }; }; /** - * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * @description A release, pre-release, or draft of a release was published. @@ -113027,7 +114540,7 @@ export interface operations { }; }; /** - * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * @description A release was published, or a pre-release was changed to a release. @@ -113064,7 +114577,7 @@ export interface operations { }; }; /** - * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + * This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * @description A release or pre-release was unpublished. @@ -113502,6 +115015,123 @@ export interface operations { }; }; }; + /** + * This event occurs when there is activity relating to repository rulesets. + * For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + * For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + * @description A repository ruleset was created. + */ + "repository-ruleset/created": { + parameters: { + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example issues */ + "X-Github-Event"?: string; + /** @example 123123 */ + "X-Github-Hook-Installation-Target-Id"?: string; + /** @example repository */ + "X-Github-Hook-Installation-Target-Type"?: string; + /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ + "X-GitHub-Delivery"?: string; + /** @example sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e */ + "X-Hub-Signature-256"?: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-repository-ruleset-created"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + content: never; + }; + }; + }; + /** + * This event occurs when there is activity relating to repository rulesets. + * For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + * For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + * @description A repository ruleset was deleted. + */ + "repository-ruleset/deleted": { + parameters: { + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example issues */ + "X-Github-Event"?: string; + /** @example 123123 */ + "X-Github-Hook-Installation-Target-Id"?: string; + /** @example repository */ + "X-Github-Hook-Installation-Target-Type"?: string; + /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ + "X-GitHub-Delivery"?: string; + /** @example sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e */ + "X-Hub-Signature-256"?: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-repository-ruleset-deleted"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + content: never; + }; + }; + }; + /** + * This event occurs when there is activity relating to repository rulesets. + * For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + * For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + * @description A repository ruleset was edited. + */ + "repository-ruleset/edited": { + parameters: { + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example issues */ + "X-Github-Event"?: string; + /** @example 123123 */ + "X-Github-Hook-Installation-Target-Id"?: string; + /** @example repository */ + "X-Github-Hook-Installation-Target-Type"?: string; + /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ + "X-GitHub-Delivery"?: string; + /** @example sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e */ + "X-Hub-Signature-256"?: string; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-repository-ruleset-edited"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + content: never; + }; + }; + }; /** * This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. * @@ -114370,7 +116000,7 @@ export interface operations { }; }; /** - * This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Statuses](https://docs.github.com/rest/reference/commits#commit-statuses)" in the REST API documentation. + * This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. */ @@ -114827,13 +116457,11 @@ export interface operations { }; }; /** - * This event occurs when there is activity relating to a job in a GitHub Actions workflow. - * - * For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see [the REST API documentation](https://docs.github.com/rest/actions/workflow-jobs). + * This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. * - * For activity relating to a workflow run instead of a job in a workflow run, see the `workflow_run` event. + * For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. * - * To install this event on a GitHub App, the app must have at least read-level access for the Actions metadata permission. + * To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. * @description A job in a workflow run was created and is waiting for approvals. */ "workflow-job/waiting": { diff --git a/packages/openapi-typescript/examples/github-api-next.yaml b/packages/openapi-typescript/examples/github-api-next.yaml index 485ef59a4..1dd22dd31 100644 --- a/packages/openapi-typescript/examples/github-api-next.yaml +++ b/packages/openapi-typescript/examples/github-api-next.yaml @@ -27,10 +27,6 @@ tags: description: Retrieve code scanning alerts from a repository. - name: codes-of-conduct description: Insight into codes of conduct for your communities. -- name: codespaces - description: Endpoints to manage Codespaces using the REST API. -- name: copilot - description: Endpoints to manage Copilot using the REST API. - name: emojis description: List emojis available to use on GitHub. - name: dependabot @@ -43,8 +39,6 @@ tags: description: Raw Git functionality. - name: gitignore description: View gitignore templates -- name: interactions - description: Owner or admin management of users interactions. - name: issues description: Interact with GitHub Issues. - name: licenses @@ -77,12 +71,18 @@ tags: description: Look for stuff on GitHub. - name: secret-scanning description: Retrieve secret scanning alerts from a repository. -- name: security-advisories - description: Manage security advisories. - name: teams description: Interact with GitHub Teams. - name: users description: Interact with and view information about users and also current user. +- name: codespaces + description: Endpoints to manage Codespaces using the REST API. +- name: copilot + description: Endpoints to manage Copilot using the REST API. +- name: security-advisories + description: Manage security advisories. +- name: interactions + description: Owner or admin management of users interactions. servers: - url: https://api.github.com externalDocs: @@ -117,8 +117,10 @@ paths: "/advisories": get: summary: List global security advisories - description: List global security advisories and filter using parameters such - as ecosystem, GHSA ID, CVE ID, etc. + description: |- + Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. + + 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)." tags: - security-advisories operationId: security-advisories/list-global-advisories @@ -181,8 +183,10 @@ paths: - critical - name: cwes in: query - description: If specified, only advisories with these Common Weakness Enumerations - (CWEs) will be returned. + description: |- + If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. + + Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` schema: oneOf: - type: string @@ -196,10 +200,11 @@ paths: type: boolean - name: affects in: query - description: If specified, return advisories that affect any of `package` - or `package@version`. A maximum of 1000 packages can be specified. If the - query parameter causes the URL to exceed the maximum URL length supported - by your client, you must specify fewer packages. + description: |- + If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. + If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. + + Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` schema: oneOf: - type: string @@ -686,7 +691,7 @@ paths: delete: summary: Delete an installation for the authenticated app description: |- - Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. + Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. 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. tags: @@ -2370,7 +2375,7 @@ paths: description: |- Revokes the installation token you're using to authenticate as an installation and access this endpoint. - Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app)" endpoint. + Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. 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. tags: @@ -2502,7 +2507,8 @@ paths: "/licenses": get: summary: Get all commonly used licenses - description: '' + 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)." tags: - licenses operationId: licenses/get-all-commonly-used @@ -2539,7 +2545,8 @@ paths: "/licenses/{license}": get: summary: Get a license - description: '' + description: Gets information about a specific license. For more information, + see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." tags: - licenses operationId: licenses/get @@ -7279,7 +7286,6 @@ paths: config: type: object description: Key/value pairs to provide settings for this webhook. - [These are defined below](https://docs.github.com/rest/reference/orgs#create-hook-config-params). properties: url: "$ref": "#/components/schemas/webhook-config-url" @@ -7408,7 +7414,6 @@ paths: config: type: object description: Key/value pairs to provide settings for this webhook. - [These are defined below](https://docs.github.com/rest/reference/orgs#update-hook-config-params). properties: url: "$ref": "#/components/schemas/webhook-config-url" @@ -9034,7 +9039,7 @@ paths: value: message: You cannot specify an organization member to remove as an outside collaborator. - documentation_url: https://docs.github.com/rest/reference/orgs#remove-outside-collaborator + documentation_url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -10661,6 +10666,77 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/orgs/{org}/security-advisories": + get: + summary: List repository security advisories for an organization + description: |- + Lists repository security advisories for an organization. + + To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission. + tags: + - security-advisories + operationId: security-advisories/list-org-repository-advisories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/direction" + - name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - published + default: created + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - name: per_page + description: The number of advisories to return per page. + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: state + description: Filter by the state of the repository advisories. Only advisories + of this state will be returned. + in: query + required: false + schema: + type: string + enum: + - triage + - draft + - published + - closed + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/repository-advisory" + examples: + default: + "$ref": "#/components/examples/list-repository-advisories" + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories "/orgs/{org}/security-managers": get: summary: List security manager teams @@ -11554,7 +11630,7 @@ paths: get: summary: List reactions for a team discussion comment description: |- - List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. tags: @@ -11569,7 +11645,7 @@ paths: - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/comment-number" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. in: query required: false @@ -11609,7 +11685,7 @@ paths: post: summary: Create reaction for a team discussion comment description: |- - Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. tags: @@ -11632,7 +11708,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. enum: - "+1" @@ -11680,7 +11756,7 @@ paths: description: |- **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). tags: - reactions operationId: reactions/delete-for-team-discussion-comment @@ -11705,7 +11781,7 @@ paths: get: summary: List reactions for a team discussion description: |- - List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. tags: @@ -11719,7 +11795,7 @@ paths: - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/discussion-number" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. in: query required: false @@ -11759,7 +11835,7 @@ paths: post: summary: Create reaction for a team discussion description: |- - Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. tags: @@ -11781,7 +11857,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. enum: - "+1" @@ -11828,7 +11904,7 @@ paths: description: |- **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). tags: - reactions operationId: reactions/delete-for-team-discussion @@ -13516,6 +13592,17 @@ paths: description: |- **Note:** Accessing this endpoint does not count against your REST API rate limit. + Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + * The `core` object provides your rate limit status for all non-search-related resources in the REST API. + * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." + * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." + * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." + * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/overview/api-versions)." + **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. tags: - rate-limit @@ -19307,7 +19394,7 @@ paths: to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs - and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." + and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -19622,10 +19709,9 @@ paths: type: array description: Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` - and `description`. A maximum of three actions are accepted. See - the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." + and `description`. A maximum of three actions are accepted. To + learn more about check runs and requested actions, see "[Check + runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -19805,7 +19891,7 @@ paths: description: |- **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. tags: - checks operationId: checks/create-suite @@ -20731,11 +20817,12 @@ paths: with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use - this endpoint.\n\nThere are two places where you can upload code scanning - results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` - or `--ref refs/pull/42/head`, then the results appear as alerts in a pull - request check. For more information, see \"[Triaging code scanning alerts - in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n + this endpoint. For troubleshooting information, see \"[Troubleshooting SARIF + uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere + are two places where you can upload code scanning results.\n - If you upload + to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, + then the results appear as alerts in a pull request check. For more information, + see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou @@ -20748,8 +20835,10 @@ paths: the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and - remove the most noisy queries.\n\n\n| **SARIF data** | **Maximum - values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| + remove the most noisy queries. For more information, see \"[SARIF results + exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| + **SARIF data** | **Maximum values** | **Additional limits** + \ |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per @@ -21615,7 +21704,7 @@ paths: Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." - The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations). + The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). **Updating an existing collaborator's permission level** @@ -21768,7 +21857,7 @@ paths: get: summary: List commit comments for a repository description: |- - Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). Comments are ordered by ascending ID. tags: @@ -21905,7 +21994,7 @@ paths: "/repos/{owner}/{repo}/comments/{comment_id}/reactions": get: summary: List reactions for a commit comment - description: List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + description: List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). tags: - reactions operationId: reactions/list-for-commit-comment @@ -21917,7 +22006,7 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. in: query required: false @@ -21958,7 +22047,7 @@ paths: subcategory: reactions post: summary: Create reaction for a commit comment - description: Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + description: Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. tags: @@ -21980,7 +22069,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment. enum: - "+1" @@ -22029,7 +22118,7 @@ paths: description: |- **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. - Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). tags: - reactions operationId: reactions/delete-for-commit-comment @@ -22752,12 +22841,12 @@ paths: the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks - support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) + support [a custom media type](https://docs.github.com/rest/overview/media-types) for\nretrieving the raw content or rendered HTML (when supported). All content - types support [a custom media\ntype](https://docs.github.com/rest/reference/repos#custom-media-types) + types support [a custom media\ntype](https://docs.github.com/rest/overview/media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n* \ To get a repository's contents recursively, you can [recursively get the - tree](https://docs.github.com/rest/reference/git#trees).\n* This API has + tree](https://docs.github.com/rest/git/trees#get-a-tree).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/rest/git/trees#get-a-tree).\n * Download URLs expire and are meant to be used just once. To ensure the @@ -22853,7 +22942,7 @@ paths: description: |- Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. - **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. tags: - repos operationId: repos/create-or-update-file-contents @@ -22993,7 +23082,7 @@ paths: You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. - **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. tags: - repos operationId: repos/delete-file @@ -24288,7 +24377,7 @@ paths: **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." - **Note:** To create or update secrets for an environment, see "[Secrets](/rest/reference/actions#secrets)." + **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. tags: @@ -25444,12 +25533,13 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: The name of the fully qualified reference to update. For example, - `refs/heads/master`. If the value doesn't start with `refs` and have at - least two slashes, it will be rejected. + description: The name of the reference to update (for example, `heads/featureA`). + Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). + For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" + in the Git documentation. in: path required: true - example: refs/head/master + example: heads/featureA schema: type: string x-multi-segment: true @@ -25821,7 +25911,7 @@ paths: get: summary: Get a tree description: |- - Returns a single tree using the SHA1 value for that tree. + Returns a single tree using the SHA1 value or ref name for that tree. If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. @@ -25837,6 +25927,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: tree_sha + description: The SHA1 value or ref (branch or tag) name of the tree. in: path required: true schema: @@ -25941,7 +26032,6 @@ paths: config: type: object description: Key/value pairs to provide settings for this webhook. - [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). properties: url: "$ref": "#/components/schemas/webhook-config-url" @@ -26015,7 +26105,7 @@ paths: get: summary: Get a repository webhook description: Returns a webhook configured in a repository. To get only the webhook - `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." + `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." tags: - repos operationId: repos/get-webhook @@ -26048,7 +26138,7 @@ paths: description: Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook - `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." + `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." tags: - repos operationId: repos/update-webhook @@ -26069,7 +26159,6 @@ paths: config: type: object description: Key/value pairs to provide settings for this webhook. - [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). properties: url: "$ref": "#/components/schemas/webhook-config-url" @@ -26166,7 +26255,7 @@ paths: get: summary: Get a webhook configuration for a repository description: |- - Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." + Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. tags: @@ -26197,7 +26286,7 @@ paths: patch: summary: Update a webhook configuration for a repository description: |- - Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." + Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. tags: @@ -27506,7 +27595,7 @@ paths: "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": get: summary: List reactions for an issue comment - description: List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + description: List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). tags: - reactions operationId: reactions/list-for-issue-comment @@ -27518,7 +27607,7 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. in: query required: false @@ -27559,7 +27648,7 @@ paths: subcategory: reactions post: summary: Create reaction for an issue comment - description: Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + description: Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. tags: @@ -27581,7 +27670,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment. enum: - "+1" @@ -27630,7 +27719,7 @@ paths: description: |- **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. - Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). tags: - reactions operationId: reactions/delete-for-issue-comment @@ -28576,7 +28665,7 @@ paths: "/repos/{owner}/{repo}/issues/{issue_number}/reactions": get: summary: List reactions for an issue - description: List the reactions to an [issue](https://docs.github.com/rest/reference/issues). + description: List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). tags: - reactions operationId: reactions/list-for-issue @@ -28588,7 +28677,7 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. in: query required: false @@ -28631,7 +28720,7 @@ paths: subcategory: reactions post: summary: Create reaction for an issue - description: Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). + description: Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. tags: @@ -28653,7 +28742,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue. enum: - "+1" @@ -28702,7 +28791,7 @@ paths: description: |- **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. - Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). + Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). tags: - reactions operationId: reactions/delete-for-issue @@ -29168,56 +29257,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repos/{owner}/{repo}/lfs": - put: - summary: Enable Git LFS for a repository - description: Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` - scope. - operationId: repos/enable-lfs-for-repo - tags: - - repos - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/lfs#enable-git-lfs-for-a-repository - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - responses: - '202': - "$ref": "#/components/responses/accepted" - '403': - description: |- - We will return a 403 with one of the following messages: - - - Git LFS support not enabled because Git LFS is globally disabled. - - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. - - Git LFS support not enabled because Git LFS is disabled for . - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: repos - subcategory: lfs - delete: - summary: Disable Git LFS for a repository - description: Disables Git LFS for a repository. Access tokens must have the - `admin:enterprise` scope. - operationId: repos/disable-lfs-for-repo - tags: - - repos - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/lfs#disable-git-lfs-for-a-repository - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: repos - subcategory: lfs "/repos/{owner}/{repo}/license": get: summary: Get the license for a repository @@ -30257,6 +30296,55 @@ paths: enabledForGitHubApps: true category: pages subcategory: pages + "/repos/{owner}/{repo}/private-vulnerability-reporting": + put: + summary: Enable private vulnerability reporting for a repository + description: Enables private vulnerability reporting for a repository. The authenticated + user must have admin access to the repository. For more information, see "[Privately + reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." + tags: + - repos + operationId: repos/enable-private-vulnerability-reporting + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + "$ref": "#/components/responses/no_content" + '422': + "$ref": "#/components/responses/bad_request" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + delete: + summary: Disable private vulnerability reporting for a repository + description: Disables private vulnerability reporting for a repository. The + authenticated user must have admin access to the repository. For more information, + see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". + tags: + - repos + operationId: repos/disable-private-vulnerability-reporting + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + "$ref": "#/components/responses/no_content" + '422': + "$ref": "#/components/responses/bad_request" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos "/repos/{owner}/{repo}/projects": get: summary: List repository projects @@ -30728,7 +30816,7 @@ paths: "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": get: summary: List reactions for a pull request review comment - description: List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + description: List the reactions to a [pull request review comment](https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request). tags: - reactions operationId: reactions/list-for-pull-request-review-comment @@ -30740,7 +30828,7 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. in: query required: false @@ -30781,7 +30869,7 @@ paths: subcategory: reactions post: summary: Create reaction for a pull request review comment - description: Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). + description: Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. tags: @@ -30803,7 +30891,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment. enum: - "+1" @@ -30852,7 +30940,7 @@ paths: description: |- **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` - Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). tags: - reactions operationId: reactions/delete-for-pull-request-comment @@ -30880,7 +30968,7 @@ paths: Lists details of a pull request by providing its number. - When you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. @@ -31354,7 +31442,7 @@ paths: summary: List commits on a pull request description: Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the - [List commits](https://docs.github.com/rest/reference/repos#list-commits) + [List commits](https://docs.github.com/rest/commits/commits#list-commits) endpoint. tags: - pulls @@ -31757,7 +31845,7 @@ paths: description: |- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. - Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request)." + Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. @@ -31795,7 +31883,7 @@ paths: description: 'The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, - which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request) + which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.' enum: - APPROVE @@ -32027,7 +32115,7 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": put: summary: Dismiss a review for a pull request - description: "**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), + description: "**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews." tags: @@ -32088,7 +32176,7 @@ paths: summary: Submit a review for a pull request description: Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review - for a pull request](https://docs.github.com/rest/pulls#create-a-review-for-a-pull-request)." + for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." tags: - pulls operationId: pulls/submit-review @@ -32180,7 +32268,7 @@ paths: This is the most recent commit on the pull request''s branch. If the expected SHA does not match the pull request''s HEAD, you will receive a `422 Unprocessable Entity` status. You can use - the "[List commits](https://docs.github.com/rest/reference/repos#list-commits)" + the "[List commits](https://docs.github.com/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request''s current HEAD ref.' examples: @@ -32219,7 +32307,7 @@ paths: description: |- Gets the preferred README for a repository. - READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. tags: - repos operationId: repos/get-readme @@ -32261,7 +32349,7 @@ paths: description: |- Gets the README from a repository directory. - READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. tags: - repos operationId: repos/get-readme-in-directory @@ -32569,7 +32657,7 @@ paths: "/repos/{owner}/{repo}/releases/generate-notes": post: summary: Generate release notes content for a release - description: Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). + description: Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when @@ -32907,7 +32995,7 @@ paths: receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub renames asset filenames that have special characters, non-alphanumeric characters, - and leading or trailing periods. The \"[List assets for a release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)\"\nendpoint + and leading or trailing periods. The \"[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` @@ -32970,7 +33058,7 @@ paths: "/repos/{owner}/{repo}/releases/{release_id}/reactions": get: summary: List reactions for a release - description: List the reactions to a [release](https://docs.github.com/rest/reference/repos#releases). + description: List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release). tags: - reactions operationId: reactions/list-for-release @@ -32982,7 +33070,7 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/release-id" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. in: query required: false @@ -33021,7 +33109,7 @@ paths: subcategory: reactions post: summary: Create reaction for a release - description: 'Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). + description: 'Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.' tags: @@ -33043,7 +33131,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release. enum: - "+1" @@ -33090,7 +33178,7 @@ paths: description: |- **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. - Delete a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). + Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). tags: - reactions operationId: reactions/delete-for-release @@ -34008,6 +34096,43 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: repository-advisories + "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": + post: + summary: Request a CVE for a repository security advisory + description: |- + If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." + + You may request a CVE for public repositories, but cannot do so for private repositories. + + You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + + In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + tags: + - security-advisories + operationId: security-advisories/create-repository-advisory-cve-request + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/ghsa_id" + responses: + '202': + "$ref": "#/components/responses/accepted" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories "/repos/{owner}/{repo}/stargazers": get: summary: List stargazers @@ -35638,7 +35763,7 @@ paths: description: |- Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). - When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: @@ -35667,7 +35792,7 @@ paths: description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). + learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. in: query @@ -35678,7 +35803,7 @@ paths: deprecated: true description: "**This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed - by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)" + by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)" in: query required: false schema: @@ -35743,7 +35868,7 @@ paths: Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match - metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + metadata](https://docs.github.com/rest/search/search#text-match-metadata). For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: @@ -35759,7 +35884,7 @@ paths: description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). + learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. in: query @@ -35768,7 +35893,7 @@ paths: type: string - name: sort description: 'Sorts the results of your query by `author-date` or `committer-date`. - Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)' + Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -35816,7 +35941,7 @@ paths: Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. @@ -35836,7 +35961,7 @@ paths: description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). + learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. in: query @@ -35848,7 +35973,7 @@ paths: `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: - [best match](https://docs.github.com/rest/reference/search#ranking-search-results)' + [best match](https://docs.github.com/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -35910,7 +36035,7 @@ paths: description: |- Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). - When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: @@ -35933,14 +36058,14 @@ paths: - name: q description: The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing - a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). + a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). in: query required: true schema: type: string - name: sort description: 'Sorts the results of your query by when the label was `created` - or `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)' + or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -35993,7 +36118,7 @@ paths: description: |- Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). - When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: @@ -36011,7 +36136,7 @@ paths: description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). + learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. in: query @@ -36021,7 +36146,7 @@ paths: - name: sort description: 'Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: - [best match](https://docs.github.com/rest/reference/search#ranking-search-results)' + [best match](https://docs.github.com/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -36074,7 +36199,7 @@ paths: description: |- Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. - When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: @@ -36092,7 +36217,7 @@ paths: description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). + learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). in: query required: true schema: @@ -36135,7 +36260,7 @@ paths: description: |- Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). - When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For example, if you're looking for a list of popular users, you might try this query: @@ -36155,7 +36280,7 @@ paths: description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). + learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. in: query @@ -36164,7 +36289,7 @@ paths: type: string - name: sort description: 'Sorts the results of your query by number of `followers` or - `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)' + `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -36809,7 +36934,7 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). tags: - reactions operationId: reactions/list-for-team-discussion-comment-legacy @@ -36821,7 +36946,7 @@ paths: - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/comment-number" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. in: query required: false @@ -36866,7 +36991,7 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. tags: - reactions operationId: reactions/create-for-team-discussion-comment-legacy @@ -36886,7 +37011,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. enum: - "+1" @@ -36927,7 +37052,7 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). tags: - reactions operationId: reactions/list-for-team-discussion-legacy @@ -36938,7 +37063,7 @@ paths: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/discussion-number" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. in: query required: false @@ -36983,7 +37108,7 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. tags: - reactions operationId: reactions/create-for-team-discussion-legacy @@ -37002,7 +37127,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. enum: - "+1" @@ -37605,7 +37730,7 @@ paths: description: |- **Note**: Repositories inherited through a parent team will also be checked. - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-repository) endpoint. + **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: tags: @@ -37643,7 +37768,7 @@ paths: put: summary: Add or update team repository permissions (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. + **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. @@ -37698,7 +37823,7 @@ paths: delete: summary: Remove a repository from a team (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. + **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. tags: @@ -38374,7 +38499,7 @@ paths: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for - the authenticated user](https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user) + the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -42245,7 +42370,7 @@ paths: The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). - The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". + The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". tags: - users operationId: users/get-by-username @@ -43514,7 +43639,7 @@ paths: '200': description: Response content: - text/plain: + application/json: schema: type: string examples: @@ -43532,7 +43657,7 @@ webhooks: summary: |- This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/rest/branches/branch-protection)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A branch protection rule was created. operationId: branch-protection-rule/created externalDocs: @@ -45579,18 +45704,18 @@ webhooks: subcategory: deployment-protection-rule supported-webhook-types: - app - deployment-status-created: + deployment-review-approved: post: summary: |- - This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. - For activity relating to deployment creation, use the `deployment` event. + For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A new deployment status was created. - operationId: deployment-status/created + description: A deployment review was approved. + operationId: deployment-review/approved externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-status + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-review parameters: - name: User-Agent in: header @@ -45632,7 +45757,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deployment-status-created" + "$ref": "#/components/schemas/webhook-deployment-review-approved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45640,25 +45765,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deployment-status + subcategory: deployment-review supported-webhook-types: - - repository - - organization - app - discussion-answered: + deployment-review-rejected: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A comment on the discussion was marked as the answer. - operationId: discussion/answered + To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + description: A deployment review was rejected. + operationId: deployment-review/rejected externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-review parameters: - name: User-Agent in: header @@ -45700,7 +45821,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-answered" + "$ref": "#/components/schemas/webhook-deployment-review-rejected" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45708,25 +45829,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion + subcategory: deployment-review supported-webhook-types: - - repository - - organization - app - discussion-category-changed: + deployment-review-requested: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: The category of a discussion was changed. - operationId: discussion/category-changed + To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + description: A deployment review was requested. + operationId: deployment-review/requested externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-review parameters: - name: User-Agent in: header @@ -45768,7 +45885,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-category-changed" + "$ref": "#/components/schemas/webhook-deployment-review-requested" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45776,25 +45893,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion + subcategory: deployment-review supported-webhook-types: - - repository - - organization - app - discussion-closed: + deployment-status-created: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. + This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + For activity relating to deployment creation, use the `deployment` event. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was closed. - operationId: discussion/closed + To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + description: A new deployment status was created. + operationId: deployment-status/created externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-status parameters: - name: User-Agent in: header @@ -45808,7 +45921,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: discussions + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -45836,7 +45949,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-closed" + "$ref": "#/components/schemas/webhook-deployment-status-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45844,25 +45957,25 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion + subcategory: deployment-status supported-webhook-types: - repository - organization - app - discussion-comment-created: + discussion-answered: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A comment on a discussion was created. - operationId: discussion-comment/created + description: A comment on the discussion was marked as the answer. + operationId: discussion/answered externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -45904,7 +46017,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-comment-created" + "$ref": "#/components/schemas/webhook-discussion-answered" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45912,25 +46025,25 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion-comment + subcategory: discussion supported-webhook-types: - repository - organization - app - discussion-comment-deleted: + discussion-category-changed: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A comment on a discussion was deleted. - operationId: discussion-comment/deleted + description: The category of a discussion was changed. + operationId: discussion/category-changed externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -45972,7 +46085,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-comment-deleted" + "$ref": "#/components/schemas/webhook-discussion-category-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45980,25 +46093,25 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion-comment + subcategory: discussion supported-webhook-types: - repository - organization - app - discussion-comment-edited: + discussion-closed: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A comment on a discussion was edited. - operationId: discussion-comment/edited + description: A discussion was closed. + operationId: discussion/closed externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -46012,7 +46125,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: issues + example: discussions schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -46040,7 +46153,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-comment-edited" + "$ref": "#/components/schemas/webhook-discussion-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46048,25 +46161,25 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion-comment + subcategory: discussion supported-webhook-types: - repository - organization - app - discussion-created: + discussion-comment-created: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - For activity relating to a comment on a discussion, use the `discussion_comment` event. + For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was created. - operationId: discussion/created + description: A comment on a discussion was created. + operationId: discussion-comment/created externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment parameters: - name: User-Agent in: header @@ -46108,7 +46221,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-created" + "$ref": "#/components/schemas/webhook-discussion-comment-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46116,25 +46229,25 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion + subcategory: discussion-comment supported-webhook-types: - repository - organization - app - discussion-deleted: + discussion-comment-deleted: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - For activity relating to a comment on a discussion, use the `discussion_comment` event. + For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was deleted. - operationId: discussion/deleted + description: A comment on a discussion was deleted. + operationId: discussion-comment/deleted externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment parameters: - name: User-Agent in: header @@ -46176,7 +46289,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-deleted" + "$ref": "#/components/schemas/webhook-discussion-comment-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46184,26 +46297,25 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion + subcategory: discussion-comment supported-webhook-types: - repository - organization - app - discussion-edited: + discussion-comment-edited: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - For activity relating to a comment on a discussion, use the `discussion_comment` event. + For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: The title or body on a discussion was edited, or the category of - the discussion was changed. - operationId: discussion/edited + description: A comment on a discussion was edited. + operationId: discussion-comment/edited externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment parameters: - name: User-Agent in: header @@ -46245,7 +46357,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-edited" + "$ref": "#/components/schemas/webhook-discussion-comment-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46253,12 +46365,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion + subcategory: discussion-comment supported-webhook-types: - repository - organization - app - discussion-labeled: + discussion-created: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46268,8 +46380,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A label was added to a discussion. - operationId: discussion/labeled + description: A discussion was created. + operationId: discussion/created externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46313,7 +46425,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-labeled" + "$ref": "#/components/schemas/webhook-discussion-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46326,7 +46438,7 @@ webhooks: - repository - organization - app - discussion-locked: + discussion-deleted: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46336,8 +46448,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was locked. - operationId: discussion/locked + description: A discussion was deleted. + operationId: discussion/deleted externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46381,7 +46493,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-locked" + "$ref": "#/components/schemas/webhook-discussion-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46394,7 +46506,7 @@ webhooks: - repository - organization - app - discussion-pinned: + discussion-edited: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46404,8 +46516,9 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was pinned. - operationId: discussion/pinned + description: The title or body on a discussion was edited, or the category of + the discussion was changed. + operationId: discussion/edited externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46449,7 +46562,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-pinned" + "$ref": "#/components/schemas/webhook-discussion-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46462,7 +46575,7 @@ webhooks: - repository - organization - app - discussion-reopened: + discussion-labeled: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46472,8 +46585,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was reopened. - operationId: discussion/reopened + description: A label was added to a discussion. + operationId: discussion/labeled externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46489,7 +46602,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: discussions + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -46517,7 +46630,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-reopened" + "$ref": "#/components/schemas/webhook-discussion-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46530,7 +46643,7 @@ webhooks: - repository - organization - app - discussion-transferred: + discussion-locked: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46540,8 +46653,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was transferred to another repository. - operationId: discussion/transferred + description: A discussion was locked. + operationId: discussion/locked externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46585,7 +46698,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-transferred" + "$ref": "#/components/schemas/webhook-discussion-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46598,7 +46711,7 @@ webhooks: - repository - organization - app - discussion-unanswered: + discussion-pinned: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46608,8 +46721,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A comment on the discussion was unmarked as the answer. - operationId: discussion/unanswered + description: A discussion was pinned. + operationId: discussion/pinned externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46653,7 +46766,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-unanswered" + "$ref": "#/components/schemas/webhook-discussion-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46666,7 +46779,7 @@ webhooks: - repository - organization - app - discussion-unlabeled: + discussion-reopened: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46676,8 +46789,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A label was removed from a discussion. - operationId: discussion/unlabeled + description: A discussion was reopened. + operationId: discussion/reopened externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46693,7 +46806,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: issues + example: discussions schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -46721,7 +46834,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-unlabeled" + "$ref": "#/components/schemas/webhook-discussion-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46734,7 +46847,7 @@ webhooks: - repository - organization - app - discussion-unlocked: + discussion-transferred: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46744,8 +46857,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was unlocked. - operationId: discussion/unlocked + description: A discussion was transferred to another repository. + operationId: discussion/transferred externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46789,7 +46902,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-unlocked" + "$ref": "#/components/schemas/webhook-discussion-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46802,7 +46915,7 @@ webhooks: - repository - organization - app - discussion-unpinned: + discussion-unanswered: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46812,8 +46925,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was unpinned. - operationId: discussion/unpinned + description: A comment on the discussion was unmarked as the answer. + operationId: discussion/unanswered externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46857,7 +46970,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-unpinned" + "$ref": "#/components/schemas/webhook-discussion-unanswered" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46870,15 +46983,20 @@ webhooks: - repository - organization - app - fork: + discussion-unlabeled: post: summary: |- - This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/rest/repos/forks)" in the REST API documentation. + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: fork + For activity relating to a comment on a discussion, use the `discussion_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + + **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + description: A label was removed from a discussion. + operationId: discussion/unlabeled externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#fork + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -46920,7 +47038,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-fork" + "$ref": "#/components/schemas/webhook-discussion-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46928,85 +47046,284 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: fork + subcategory: discussion supported-webhook-types: - - business - repository - organization - app - github-app-authorization-revoked: + discussion-unlocked: post: summary: |- - This event occurs when a user revokes their authorization of a GitHub App. For more information, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - A GitHub App receives this webhook by default and cannot unsubscribe from this event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. - Anyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - description: Someone revoked their authorization of a GitHub App. - operationId: github-app-authorization/revoked - externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#github-app-authorization - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: github-app-authorization - supported-webhook-types: - - app - gollum: - post: - summary: |- - This event occurs when someone creates or updates a wiki page. For more information, see "[About wikis](https://docs.github.com/communities/documenting-your-project-with-wikis/about-wikis)." + To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: gollum + **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + description: A discussion was unlocked. + operationId: discussion/unlocked externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#gollum + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-discussion-unlocked" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: discussion + supported-webhook-types: + - repository + - organization + - app + discussion-unpinned: + post: + summary: |- + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). + + For activity relating to a comment on a discussion, use the `discussion_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + + **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + description: A discussion was unpinned. + operationId: discussion/unpinned + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-discussion-unpinned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: discussion + supported-webhook-types: + - repository + - organization + - app + fork: + post: + summary: |- + This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/rest/repos/forks)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + operationId: fork + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#fork + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-fork" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: fork + supported-webhook-types: + - business + - repository + - organization + - app + github-app-authorization-revoked: + post: + summary: |- + This event occurs when a user revokes their authorization of a GitHub App. For more information, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. + + A GitHub App receives this webhook by default and cannot unsubscribe from this event. + + Anyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." + description: Someone revoked their authorization of a GitHub App. + operationId: github-app-authorization/revoked + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#github-app-authorization + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: github-app-authorization + supported-webhook-types: + - app + gollum: + post: + summary: |- + This event occurs when someone creates or updates a wiki page. For more information, see "[About wikis](https://docs.github.com/communities/documenting-your-project-with-wikis/about-wikis)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + operationId: gollum + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#gollum parameters: - name: User-Agent in: header @@ -47066,7 +47383,7 @@ webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. description: Someone installed a GitHub App on a user or organization account. operationId: installation/created externalDocs: @@ -47128,7 +47445,7 @@ webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. description: Someone uninstalled a GitHub App from their user or organization account. operationId: installation/deleted @@ -47191,7 +47508,7 @@ webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. description: Someone granted new permissions to a GitHub App. operationId: installation/new-permissions-accepted externalDocs: @@ -47253,7 +47570,7 @@ webhooks: summary: |- This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. description: A GitHub App installation was granted access to one or more repositories. operationId: installation-repositories/added externalDocs: @@ -47315,7 +47632,7 @@ webhooks: summary: |- This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. description: Access to one or more repositories was revoked for a GitHub App installation. operationId: installation-repositories/removed @@ -47378,7 +47695,7 @@ webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. description: Someone blocked access by a GitHub App to their user or organization account. operationId: installation/suspend @@ -47442,7 +47759,7 @@ webhooks: account that a GitHub App is installed on. For more information, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API - documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" + documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. description: Somebody renamed the user or organization account that a GitHub App is installed on. @@ -47506,7 +47823,7 @@ webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. description: A GitHub App that was blocked from accessing a user or organization account was given access the account again. operationId: installation/unsuspend @@ -49612,7 +49929,7 @@ webhooks: membership-removed: post: summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: An organization member was removed from a team. @@ -53921,7 +54238,7 @@ webhooks: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A previously closed pull request was reopened. @@ -54515,7 +54832,7 @@ webhooks: pull-request-review-thread-resolved: post: summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request review comment threads, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. @@ -54915,7 +55232,7 @@ webhooks: push: post: summary: |- - This event occurs when a commit or tag is pushed. + This event occurs when a commit or tag is pushed, or when a repository is cloned. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. @@ -55050,7 +55367,7 @@ webhooks: To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. - **Note**: GitHub recommends that you use the newer `package` event instead + **Note**: GitHub recommends that you use the newer `package` event instead. description: A package that was previously published to a registry was updated. operationId: registry-package/updated externalDocs: @@ -55177,7 +55494,7 @@ webhooks: release-deleted: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release, pre-release, or draft release was deleted. @@ -55241,7 +55558,7 @@ webhooks: release-edited: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: The details of a release, pre-release, or draft release were edited. @@ -55306,7 +55623,7 @@ webhooks: release-prereleased: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release was created and identified as a pre-release. A pre-release @@ -55371,7 +55688,7 @@ webhooks: release-published: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release, pre-release, or draft of a release was published. @@ -55435,7 +55752,7 @@ webhooks: release-released: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release was published, or a pre-release was changed to a release. @@ -55499,7 +55816,7 @@ webhooks: release-unpublished: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release or pre-release was unpublished. @@ -56269,20 +56586,18 @@ webhooks: - repository - organization - app - repository-transferred: + repository-ruleset-created: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - 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. - operationId: repository/transferred + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + description: A repository ruleset was created. + operationId: repository-ruleset/created externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-ruleset parameters: - name: User-Agent in: header @@ -56324,7 +56639,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56332,22 +56647,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository-ruleset supported-webhook-types: - - business - repository - organization - app - repository-unarchived: + repository-ruleset-deleted: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A previously archived repository was unarchived. - operationId: repository/unarchived + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + description: A repository ruleset was deleted. + operationId: repository-ruleset/deleted externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-ruleset parameters: - name: User-Agent in: header @@ -56389,7 +56705,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56397,22 +56713,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository-ruleset supported-webhook-types: - - business - repository - organization - app - repository-vulnerability-alert-create: + repository-ruleset-edited: post: summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - **Note**: This event is deprecated. Use the `dependabot_alert` event instead. - description: A repository vulnerability alert was created. - operationId: repository-vulnerability-alert/create + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + description: A repository ruleset was edited. + operationId: repository-ruleset/edited externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-ruleset parameters: - name: User-Agent in: header @@ -56454,7 +56771,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56462,20 +56779,25 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository-vulnerability-alert + subcategory: repository-ruleset supported-webhook-types: - repository - organization - repository-vulnerability-alert-dismiss: + - app + repository-transferred: post: summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - **Note**: This event is deprecated. Use the `dependabot_alert` event instead. - description: A repository vulnerability alert was dismissed. - operationId: repository-vulnerability-alert/dismiss + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + 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. + operationId: repository/transferred externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -56517,7 +56839,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56525,19 +56847,85 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository-vulnerability-alert + subcategory: repository supported-webhook-types: + - business - repository - organization - repository-vulnerability-alert-reopen: + - app + repository-unarchived: + post: + summary: |- + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A previously archived repository was unarchived. + operationId: repository/unarchived + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-repository-unarchived" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: repository + supported-webhook-types: + - business + - repository + - organization + - app + repository-vulnerability-alert-create: post: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. **Note**: This event is deprecated. Use the `dependabot_alert` event instead. - description: A previously dismissed or resolved repository vulnerability alert - was reopened. - operationId: repository-vulnerability-alert/reopen + description: A repository vulnerability alert was created. + operationId: repository-vulnerability-alert/create externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert parameters: @@ -56581,7 +56969,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56593,14 +56981,14 @@ webhooks: supported-webhook-types: - repository - organization - repository-vulnerability-alert-resolve: + repository-vulnerability-alert-dismiss: post: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. **Note**: This event is deprecated. Use the `dependabot_alert` event instead. - description: A repository vulnerability alert was marked as resolved. - operationId: repository-vulnerability-alert/resolve + description: A repository vulnerability alert was dismissed. + operationId: repository-vulnerability-alert/dismiss externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert parameters: @@ -56644,7 +57032,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56656,18 +57044,17 @@ webhooks: supported-webhook-types: - repository - organization - secret-scanning-alert-created: + repository-vulnerability-alert-reopen: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + This event occurs when there is activity relating to a security vulnerability alert in a repository. - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was created. - operationId: secret-scanning-alert/created + **Note**: This event is deprecated. Use the `dependabot_alert` event instead. + description: A previously dismissed or resolved repository vulnerability alert + was reopened. + operationId: repository-vulnerability-alert/reopen externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert parameters: - name: User-Agent in: header @@ -56709,7 +57096,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56717,26 +57104,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: secret-scanning-alert + subcategory: repository-vulnerability-alert supported-webhook-types: - repository - organization - - app - secret-scanning-alert-location-created: + repository-vulnerability-alert-resolve: post: summary: |- - This event occurs when there is activity relating to the locations of a secret in a secret scanning alert. - - For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - - For activity relating to secret scanning alerts, use the `secret_scanning_alert` event. + This event occurs when there is activity relating to a security vulnerability alert in a repository. - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - 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. - operationId: secret-scanning-alert-location/created + **Note**: This event is deprecated. Use the `dependabot_alert` event instead. + description: A repository vulnerability alert was marked as resolved. + operationId: repository-vulnerability-alert/resolve externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret_scanning_alert_location + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert parameters: - name: User-Agent in: header @@ -56778,30 +57159,19 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - examples: - default: - "$ref": "#/components/examples/secret-scanning-alert-location-created" - application/x-www-form-urlencoded: - schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" - examples: - default: - "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: secret_scanning_alert_location + subcategory: repository-vulnerability-alert supported-webhook-types: - repository - organization - - app - secret-scanning-alert-reopened: + secret-scanning-alert-created: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -56809,8 +57179,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A previously closed secret scanning alert was reopened. - operationId: secret-scanning-alert/reopened + description: A secret scanning alert was created. + operationId: secret-scanning-alert/created externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert parameters: @@ -56854,7 +57224,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56867,18 +57237,21 @@ webhooks: - repository - organization - app - secret-scanning-alert-resolved: + secret-scanning-alert-location-created: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to the locations of a secret in a secret scanning alert. - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alerts, use the `secret_scanning_alert` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was closed. - operationId: secret-scanning-alert/resolved + 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. + operationId: secret-scanning-alert-location/created externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret_scanning_alert_location parameters: - name: User-Agent in: header @@ -56920,20 +57293,30 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + examples: + default: + "$ref": "#/components/examples/secret-scanning-alert-location-created" + application/x-www-form-urlencoded: + schema: + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + examples: + default: + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: secret-scanning-alert + subcategory: secret_scanning_alert_location supported-webhook-types: - repository - organization - app - secret-scanning-alert-revoked: + secret-scanning-alert-reopened: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -56941,8 +57324,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was marked as revoked. - operationId: secret-scanning-alert/revoked + description: A previously closed secret scanning alert was reopened. + operationId: secret-scanning-alert/reopened externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert parameters: @@ -56986,7 +57369,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-revoked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56999,16 +57382,18 @@ webhooks: - repository - organization - app - security-advisory-published: + secret-scanning-alert-resolved: post: summary: |- - This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A security advisory was published to the GitHub community. - operationId: security-advisory/published + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was closed. + operationId: secret-scanning-alert/resolved externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert parameters: - name: User-Agent in: header @@ -57050,7 +57435,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57058,20 +57443,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security-advisory + subcategory: secret-scanning-alert supported-webhook-types: + - repository + - organization - app - security-advisory-updated: + secret-scanning-alert-revoked: post: summary: |- - This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: The metadata or description of a security advisory was changed, - or the security advisory was withdrawn. - operationId: security-advisory/updated + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was marked as revoked. + operationId: secret-scanning-alert/revoked externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert parameters: - name: User-Agent in: header @@ -57113,7 +57501,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-revoked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57121,17 +57509,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security-advisory + subcategory: secret-scanning-alert supported-webhook-types: + - repository + - organization - app - security-advisory-withdrawn: + security-advisory-published: post: summary: |- This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A previously published security advisory was withdrawn. - operationId: security-advisory/withdrawn + description: A security advisory was published to the GitHub community. + operationId: security-advisory/published externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory parameters: @@ -57175,7 +57565,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57186,15 +57576,17 @@ webhooks: subcategory: security-advisory supported-webhook-types: - app - security-and-analysis: + security-advisory-updated: post: summary: |- - This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." + This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - operationId: security-and-analysis + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + description: The metadata or description of a security advisory was changed, + or the security advisory was withdrawn. + operationId: security-advisory/updated externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-and-analysis + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory parameters: - name: User-Agent in: header @@ -57236,7 +57628,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57244,87 +57636,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security-and-analysis + subcategory: security-advisory supported-webhook-types: - - repository - - organization - app - sponsorship-cancelled: - post: - summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: |- - A sponsorship was cancelled and the last billing cycle has ended. - - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/cancelled - externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sponsorship - supported-webhook-types: - - sponsors_listing - sponsorship-created: + security-advisory-withdrawn: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor created a sponsorship for a sponsored account. This event - occurs once the payment is successfully processed. - operationId: sponsorship/created + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + description: A previously published security advisory was withdrawn. + operationId: security-advisory/withdrawn externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory parameters: - name: User-Agent in: header @@ -57366,7 +57690,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57374,21 +57698,18 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: security-advisory supported-webhook-types: - - sponsors_listing - sponsorship-edited: + - app + security-and-analysis: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - 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. - operationId: sponsorship/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + operationId: security-and-analysis externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-and-analysis parameters: - name: User-Agent in: header @@ -57430,7 +57751,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-security-and-analysis" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57438,20 +57759,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: security-and-analysis supported-webhook-types: - - sponsors_listing - sponsorship-pending-cancellation: + - repository + - organization + - app + sponsorship-cancelled: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: |- - A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. + A sponsorship was cancelled and the last billing cycle has ended. This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/pending-cancellation + operationId: sponsorship/cancelled externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -57495,7 +57818,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57506,15 +57829,15 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-pending-tier-change: + sponsorship-created: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor scheduled a downgrade to a lower sponsorship tier. The - new tier will become effective on their next billing date. - operationId: sponsorship/pending-tier-change + description: A sponsor created a sponsorship for a sponsored account. This event + occurs once the payment is successfully processed. + operationId: sponsorship/created externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -57558,7 +57881,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57569,17 +57892,16 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-tier-changed: + sponsorship-edited: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - 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. - operationId: sponsorship/tier-changed + 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. + operationId: sponsorship/edited externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -57623,7 +57945,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57634,80 +57956,273 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - star-created: + sponsorship-pending-cancellation: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone starred a repository. - operationId: star/created - externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#star - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-star-created" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: star - supported-webhook-types: - - repository - - organization - - app - star-deleted: - post: - summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: |- + A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone unstarred the repository. - operationId: star/deleted + This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. + operationId: sponsorship/pending-cancellation externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sponsorship + supported-webhook-types: + - sponsors_listing + sponsorship-pending-tier-change: + post: + summary: |- + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: A sponsor scheduled a downgrade to a lower sponsorship tier. The + new tier will become effective on their next billing date. + operationId: sponsorship/pending-tier-change + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sponsorship + supported-webhook-types: + - sponsors_listing + sponsorship-tier-changed: + post: + summary: |- + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + 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. + operationId: sponsorship/tier-changed + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sponsorship + supported-webhook-types: + - sponsors_listing + star-created: + post: + summary: |- + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone starred a repository. + operationId: star/created + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#star + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-star-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: star + supported-webhook-types: + - repository + - organization + - app + star-deleted: + post: + summary: |- + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone unstarred the repository. + operationId: star/deleted + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -57765,7 +58280,7 @@ webhooks: status: post: summary: |- - This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Statuses](https://docs.github.com/rest/reference/commits#commit-statuses)" in the REST API documentation. + This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. operationId: status @@ -58549,13 +59064,11 @@ webhooks: workflow-job-waiting: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. - - For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see [the REST API documentation](https://docs.github.com/rest/actions/workflow-jobs). + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. - For activity relating to a workflow run instead of a job in a workflow run, see the `workflow_run` event. + For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. - To install this event on a GitHub App, the app must have at least read-level access for the Actions metadata permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. description: A job in a workflow run was created and is waiting for approvals. operationId: workflow-job/waiting externalDocs: @@ -59216,8 +59729,9 @@ components: - string - 'null' format: date-time - description: The date and time of when the advisory was published in the - National Vulnerability Database, in ISO 8601 format. + description: |- + The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. + This field is only populated when the advisory is imported from the National Vulnerability Database. readOnly: true withdrawn_at: type: @@ -63671,6 +64185,12 @@ components: type: string examples: - 192.0.2.1 + github_enterprise_importer: + type: array + items: + type: string + examples: + - 192.0.2.1 web: type: array items: @@ -65327,7 +65847,7 @@ components: description: The display name of the machine includes cores, memory, and storage. examples: - - 4 cores, 8 GB RAM, 64 GB storage + - 4 cores, 16 GB RAM, 64 GB storage operating_system: type: string description: The operating system of the machine. @@ -65342,7 +65862,7 @@ components: type: integer description: How much memory is available to the codespace. examples: - - 8589934592 + - 17179869184 cpus: type: integer description: How many cores are available to the codespace. @@ -67447,6 +67967,327 @@ components: updated_at: type: string format: date-time + repository-advisory-vulnerability: + description: A product affected by the vulnerability detailed in a repository + security advisory. + type: object + properties: + package: + description: The name of the package affected by the vulnerability. + type: + - object + - 'null' + properties: + ecosystem: + "$ref": "#/components/schemas/security-advisory-ecosystems" + name: + type: + - string + - 'null' + description: The unique package name within its ecosystem. + required: + - ecosystem + - name + vulnerable_version_range: + type: + - string + - 'null' + description: The range of the package versions affected by the vulnerability. + patched_versions: + type: + - string + - 'null' + description: The package version(s) that resolve the vulnerability. + vulnerable_functions: + type: + - array + - 'null' + description: The functions in the package that are affected. + items: + type: string + required: + - package + - vulnerable_version_range + - patched_versions + - vulnerable_functions + additionalProperties: false + repository-advisory-credit: + description: A credit given to a user for a repository security advisory. + type: object + properties: + user: + "$ref": "#/components/schemas/simple-user" + type: + "$ref": "#/components/schemas/security-advisory-credit-types" + state: + type: string + description: The state of the user's acceptance of the credit. + enum: + - accepted + - declined + - pending + required: + - user + - type + - state + additionalProperties: false + repository-advisory: + description: A repository security advisory. + type: object + properties: + ghsa_id: + type: string + description: The GitHub Security Advisory ID. + readOnly: true + cve_id: + type: + - string + - 'null' + description: The Common Vulnerabilities and Exposures (CVE) ID. + url: + type: string + description: The API URL for the advisory. + html_url: + type: string + format: uri + description: The URL for the advisory. + readOnly: true + summary: + type: string + description: A short summary of the advisory. + maxLength: 1024 + description: + type: + - string + - 'null' + description: A detailed description of what the advisory entails. + maxLength: 65535 + severity: + type: + - string + - 'null' + description: The severity of the advisory. + enum: + - critical + - high + - medium + - low + - + author: + readOnly: true + description: The author of the advisory. + allOf: + - "$ref": "#/components/schemas/simple-user" + type: + - 'null' + publisher: + readOnly: true + description: The publisher of the advisory. + allOf: + - "$ref": "#/components/schemas/simple-user" + type: + - 'null' + identifiers: + type: array + items: + type: object + properties: + type: + type: string + description: The type of identifier. + enum: + - CVE + - GHSA + value: + type: string + description: The identifier value. + required: + - type + - value + readOnly: true + state: + type: string + description: The state of the advisory. + enum: + - published + - closed + - withdrawn + - draft + - triage + created_at: + type: + - string + - 'null' + format: date-time + description: The date and time of when the advisory was created, in ISO + 8601 format. + readOnly: true + updated_at: + type: + - string + - 'null' + format: date-time + description: The date and time of when the advisory was last updated, in + ISO 8601 format. + readOnly: true + published_at: + type: + - string + - 'null' + format: date-time + description: The date and time of when the advisory was published, in ISO + 8601 format. + readOnly: true + closed_at: + type: + - string + - 'null' + format: date-time + description: The date and time of when the advisory was closed, in ISO 8601 + format. + readOnly: true + withdrawn_at: + type: + - string + - 'null' + format: date-time + description: The date and time of when the advisory was withdrawn, in ISO + 8601 format. + readOnly: true + submission: + type: + - object + - 'null' + readOnly: true + properties: + accepted: + type: boolean + description: Whether a private vulnerability report was accepted by + the repository's administrators. + readOnly: true + required: + - accepted + vulnerabilities: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/repository-advisory-vulnerability" + cvss: + type: + - object + - 'null' + properties: + vector_string: + type: + - string + - 'null' + description: The CVSS vector. + score: + type: + - number + - 'null' + description: The CVSS score. + minimum: 0 + maximum: 10 + readOnly: true + required: + - vector_string + - score + cwes: + type: + - array + - 'null' + items: + type: object + properties: + cwe_id: + type: string + description: The Common Weakness Enumeration (CWE) identifier. + name: + type: string + description: The name of the CWE. + readOnly: true + required: + - cwe_id + - name + readOnly: true + cwe_ids: + type: + - array + - 'null' + description: A list of only the CWE IDs. + items: + type: string + credits: + type: + - array + - 'null' + items: + type: object + properties: + login: + type: string + description: The username of the user credited. + type: + "$ref": "#/components/schemas/security-advisory-credit-types" + credits_detailed: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/repository-advisory-credit" + readOnly: true + collaborating_users: + type: + - array + - 'null' + description: A list of users that collaborate on the advisory. + items: + "$ref": "#/components/schemas/simple-user" + collaborating_teams: + type: + - array + - 'null' + description: A list of teams that collaborate on the advisory. + items: + "$ref": "#/components/schemas/team" + private_fork: + readOnly: true + description: A temporary private fork of the advisory's repository for collaborating + on a fix. + allOf: + - "$ref": "#/components/schemas/simple-repository" + type: + - 'null' + required: + - ghsa_id + - cve_id + - url + - html_url + - summary + - description + - severity + - author + - publisher + - identifiers + - state + - created_at + - updated_at + - published_at + - closed_at + - withdrawn_at + - submission + - vulnerabilities + - cvss + - cwes + - cwe_ids + - credits + - credits_detailed + - collaborating_users + - collaborating_teams + - private_fork + additionalProperties: false actions-billing-usage: type: object properties: @@ -72622,6 +73463,14 @@ components: format: date-time examples: - '2023-12-06T14:20:20.000Z' + schedule: + description: The frequency of the periodic analysis. + type: + - string + - 'null' + enum: + - weekly + - code-scanning-default-setup-update: description: Configuration for code scanning default setup. type: object @@ -80070,327 +80919,6 @@ components: required: - type - details - repository-advisory-vulnerability: - description: A product affected by the vulnerability detailed in a repository - security advisory. - type: object - properties: - package: - description: The name of the package affected by the vulnerability. - type: - - object - - 'null' - properties: - ecosystem: - "$ref": "#/components/schemas/security-advisory-ecosystems" - name: - type: - - string - - 'null' - description: The unique package name within its ecosystem. - required: - - ecosystem - - name - vulnerable_version_range: - type: - - string - - 'null' - description: The range of the package versions affected by the vulnerability. - patched_versions: - type: - - string - - 'null' - description: The package version(s) that resolve the vulnerability. - vulnerable_functions: - type: - - array - - 'null' - description: The functions in the package that are affected. - items: - type: string - required: - - package - - vulnerable_version_range - - patched_versions - - vulnerable_functions - additionalProperties: false - repository-advisory-credit: - description: A credit given to a user for a repository security advisory. - type: object - properties: - user: - "$ref": "#/components/schemas/simple-user" - type: - "$ref": "#/components/schemas/security-advisory-credit-types" - state: - type: string - description: The state of the user's acceptance of the credit. - enum: - - accepted - - declined - - pending - required: - - user - - type - - state - additionalProperties: false - repository-advisory: - description: A repository security advisory. - type: object - properties: - ghsa_id: - type: string - description: The GitHub Security Advisory ID. - readOnly: true - cve_id: - type: - - string - - 'null' - description: The Common Vulnerabilities and Exposures (CVE) ID. - url: - type: string - description: The API URL for the advisory. - html_url: - type: string - format: uri - description: The URL for the advisory. - readOnly: true - summary: - type: string - description: A short summary of the advisory. - maxLength: 1024 - description: - type: - - string - - 'null' - description: A detailed description of what the advisory entails. - maxLength: 65535 - severity: - type: - - string - - 'null' - description: The severity of the advisory. - enum: - - critical - - high - - medium - - low - - - author: - readOnly: true - description: The author of the advisory. - allOf: - - "$ref": "#/components/schemas/simple-user" - type: - - 'null' - publisher: - readOnly: true - description: The publisher of the advisory. - allOf: - - "$ref": "#/components/schemas/simple-user" - type: - - 'null' - identifiers: - type: array - items: - type: object - properties: - type: - type: string - description: The type of identifier. - enum: - - CVE - - GHSA - value: - type: string - description: The identifier value. - required: - - type - - value - readOnly: true - state: - type: string - description: The state of the advisory. - enum: - - published - - closed - - withdrawn - - draft - - triage - created_at: - type: - - string - - 'null' - format: date-time - description: The date and time of when the advisory was created, in ISO - 8601 format. - readOnly: true - updated_at: - type: - - string - - 'null' - format: date-time - description: The date and time of when the advisory was last updated, in - ISO 8601 format. - readOnly: true - published_at: - type: - - string - - 'null' - format: date-time - description: The date and time of when the advisory was published, in ISO - 8601 format. - readOnly: true - closed_at: - type: - - string - - 'null' - format: date-time - description: The date and time of when the advisory was closed, in ISO 8601 - format. - readOnly: true - withdrawn_at: - type: - - string - - 'null' - format: date-time - description: The date and time of when the advisory was withdrawn, in ISO - 8601 format. - readOnly: true - submission: - type: - - object - - 'null' - readOnly: true - properties: - accepted: - type: boolean - description: Whether a private vulnerability report was accepted by - the repository's administrators. - readOnly: true - required: - - accepted - vulnerabilities: - type: - - array - - 'null' - items: - "$ref": "#/components/schemas/repository-advisory-vulnerability" - cvss: - type: - - object - - 'null' - properties: - vector_string: - type: - - string - - 'null' - description: The CVSS vector. - score: - type: - - number - - 'null' - description: The CVSS score. - minimum: 0 - maximum: 10 - readOnly: true - required: - - vector_string - - score - cwes: - type: - - array - - 'null' - items: - type: object - properties: - cwe_id: - type: string - description: The Common Weakness Enumeration (CWE) identifier. - name: - type: string - description: The name of the CWE. - readOnly: true - required: - - cwe_id - - name - readOnly: true - cwe_ids: - type: - - array - - 'null' - description: A list of only the CWE IDs. - items: - type: string - credits: - type: - - array - - 'null' - items: - type: object - properties: - login: - type: string - description: The username of the user credited. - type: - "$ref": "#/components/schemas/security-advisory-credit-types" - credits_detailed: - type: - - array - - 'null' - items: - "$ref": "#/components/schemas/repository-advisory-credit" - readOnly: true - collaborating_users: - type: - - array - - 'null' - description: A list of users that collaborate on the advisory. - items: - "$ref": "#/components/schemas/simple-user" - collaborating_teams: - type: - - array - - 'null' - description: A list of teams that collaborate on the advisory. - items: - "$ref": "#/components/schemas/team" - private_fork: - readOnly: true - description: A temporary private fork of the advisory's repository for collaborating - on a fix. - allOf: - - "$ref": "#/components/schemas/simple-repository" - type: - - 'null' - required: - - ghsa_id - - cve_id - - url - - html_url - - summary - - description - - severity - - author - - publisher - - identifiers - - state - - created_at - - updated_at - - published_at - - closed_at - - withdrawn_at - - submission - - vulnerabilities - - cvss - - cwes - - cwe_ids - - credits - - credits_detailed - - collaborating_users - - collaborating_teams - - private_fork - additionalProperties: false repository-advisory-create: type: object properties: @@ -84480,7 +85008,7 @@ components: enum: - completed check_suite: - description: The [check_suite](https://docs.github.com/rest/reference/checks#suites). + description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). type: object properties: after: @@ -85093,7 +85621,7 @@ components: enum: - requested check_suite: - description: The [check_suite](https://docs.github.com/rest/reference/checks#suites). + description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). type: object properties: after: @@ -85705,7 +86233,7 @@ components: enum: - rerequested check_suite: - description: The [check_suite](https://docs.github.com/rest/reference/checks#suites). + description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). type: object properties: after: @@ -87766,7 +88294,7 @@ components: enum: - created comment: - description: The [commit comment](https://docs.github.com/rest/reference/repos#get-a-commit-comment) + description: The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. type: object properties: @@ -88221,7 +88749,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" key: - description: The [`deploy key`](https://docs.github.com/rest/reference/deployments#get-a-deploy-key) + description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object properties: @@ -88280,7 +88808,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" key: - description: The [`deploy key`](https://docs.github.com/rest/reference/deployments#get-a-deploy-key) + description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object properties: @@ -88336,7 +88864,7 @@ components: - created deployment: title: Deployment - description: The [deployment](https://docs.github.com/rest/reference/deployments#list-deployments). + description: The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). type: object properties: created_at: @@ -89517,6 +90045,2438 @@ components: "$ref": "#/components/schemas/simple-installation" sender: "$ref": "#/components/schemas/simple-user" + webhook-deployment-review-approved: + type: object + properties: + action: + type: string + enum: + - approved + approver: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + comment: + type: string + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + reviewers: + type: array + items: + type: object + properties: + reviewer: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + type: + type: string + enum: + - User + sender: + "$ref": "#/components/schemas/simple-user" + since: + type: string + workflow_job_run: + type: object + properties: + conclusion: + type: + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - 'null' + status: + type: string + updated_at: + type: string + required: + - id + - name + - status + - conclusion + - html_url + - created_at + - updated_at + - environment + workflow_job_runs: + type: array + items: + type: object + properties: + conclusion: + type: + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - string + - 'null' + status: + type: string + updated_at: + type: string + workflow_run: + title: Deployment Workflow Run + type: + - object + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + artifacts_url: + type: string + cancel_url: + type: string + check_suite_id: + type: integer + check_suite_node_id: + type: string + check_suite_url: + type: string + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + display_title: + type: string + event: + type: string + head_branch: + type: string + head_commit: + type: + - object + - 'null' + head_repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: + - string + - 'null' + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + head_sha: + type: string + html_url: + type: string + format: uri + id: + type: integer + jobs_url: + type: string + logs_url: + type: string + name: + type: string + node_id: + type: string + path: + type: string + previous_attempt_url: + type: + - string + - 'null' + pull_requests: + type: array + items: + title: Check Run Pull Request + type: object + properties: + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + id: + type: integer + number: + type: integer + url: + type: string + format: uri + required: + - url + - id + - number + - head + - base + referenced_workflows: + type: + - array + - 'null' + items: + type: object + properties: + path: + type: string + ref: + type: string + sha: + type: string + required: + - path + - sha + repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: + - string + - 'null' + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + rerun_url: + type: string + run_attempt: + type: integer + run_number: + type: integer + run_started_at: + type: string + format: date-time + status: + type: string + enum: + - requested + - in_progress + - completed + - queued + - waiting + - pending + triggering_actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string + required: + - id + - name + - node_id + - head_branch + - head_sha + - run_number + - event + - status + - conclusion + - workflow_id + - check_suite_id + - check_suite_node_id + - url + - html_url + - path + - pull_requests + - created_at + - updated_at + - actor + - triggering_actor + - run_attempt + - run_started_at + - display_title + required: + - action + - workflow_run + - since + - repository + - organization + - sender + webhook-deployment-review-rejected: + type: object + properties: + action: + type: string + enum: + - rejected + approver: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + comment: + type: string + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + reviewers: + type: array + items: + type: object + properties: + reviewer: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + type: + type: string + enum: + - User + sender: + "$ref": "#/components/schemas/simple-user" + since: + type: string + workflow_job_run: + type: object + properties: + conclusion: + type: + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - 'null' + status: + type: string + updated_at: + type: string + required: + - id + - name + - status + - conclusion + - html_url + - created_at + - updated_at + - environment + workflow_job_runs: + type: array + items: + type: object + properties: + conclusion: + type: + - string + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - string + - 'null' + status: + type: string + updated_at: + type: string + workflow_run: + title: Deployment Workflow Run + type: + - object + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + artifacts_url: + type: string + cancel_url: + type: string + check_suite_id: + type: integer + check_suite_node_id: + type: string + check_suite_url: + type: string + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + event: + type: string + head_branch: + type: string + head_commit: + type: + - object + - 'null' + head_repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: + - string + - 'null' + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + head_sha: + type: string + html_url: + type: string + format: uri + id: + type: integer + jobs_url: + type: string + logs_url: + type: string + name: + type: string + node_id: + type: string + path: + type: string + previous_attempt_url: + type: + - string + - 'null' + pull_requests: + type: array + items: + title: Check Run Pull Request + type: object + properties: + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + id: + type: integer + number: + type: integer + url: + type: string + format: uri + required: + - url + - id + - number + - head + - base + referenced_workflows: + type: + - array + - 'null' + items: + type: object + properties: + path: + type: string + ref: + type: string + sha: + type: string + required: + - path + - sha + repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: + - string + - 'null' + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + rerun_url: + type: string + run_attempt: + type: integer + run_number: + type: integer + run_started_at: + type: string + format: date-time + status: + type: string + enum: + - requested + - in_progress + - completed + - queued + - waiting + triggering_actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string + display_title: + type: string + required: + - id + - name + - node_id + - head_branch + - head_sha + - run_number + - event + - status + - conclusion + - workflow_id + - check_suite_id + - check_suite_node_id + - url + - html_url + - path + - pull_requests + - created_at + - updated_at + - actor + - triggering_actor + - run_attempt + - run_started_at + - display_title + required: + - action + - workflow_run + - since + - repository + - organization + - sender + webhook-deployment-review-requested: + type: object + properties: + action: + type: string + enum: + - requested + enterprise: + "$ref": "#/components/schemas/enterprise" + environment: + type: string + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + requestor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + reviewers: + type: array + items: + type: object + properties: + reviewer: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - id + type: + type: string + enum: + - User + - Team + sender: + "$ref": "#/components/schemas/simple-user" + since: + type: string + workflow_job_run: + type: object + properties: + conclusion: + type: + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - string + - 'null' + status: + type: string + updated_at: + type: string + required: + - id + - name + - status + - conclusion + - html_url + - created_at + - updated_at + - environment + workflow_run: + title: Deployment Workflow Run + type: + - object + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + artifacts_url: + type: string + cancel_url: + type: string + check_suite_id: + type: integer + check_suite_node_id: + type: string + check_suite_url: + type: string + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + event: + type: string + head_branch: + type: string + head_commit: + type: + - object + - 'null' + head_repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: + - string + - 'null' + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + head_sha: + type: string + html_url: + type: string + format: uri + id: + type: integer + jobs_url: + type: string + logs_url: + type: string + name: + type: string + node_id: + type: string + path: + type: string + previous_attempt_url: + type: + - string + - 'null' + pull_requests: + type: array + items: + title: Check Run Pull Request + type: object + properties: + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + id: + type: integer + number: + type: integer + url: + type: string + format: uri + required: + - url + - id + - number + - head + - base + referenced_workflows: + type: + - array + - 'null' + items: + type: object + properties: + path: + type: string + ref: + type: string + sha: + type: string + required: + - path + - sha + repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: + - string + - 'null' + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + rerun_url: + type: string + run_attempt: + type: integer + run_number: + type: integer + run_started_at: + type: string + format: date-time + status: + type: string + enum: + - requested + - in_progress + - completed + - queued + - waiting + - pending + triggering_actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string + display_title: + type: string + required: + - id + - name + - node_id + - head_branch + - head_sha + - run_number + - event + - status + - conclusion + - workflow_id + - check_suite_id + - check_suite_node_id + - url + - html_url + - path + - pull_requests + - created_at + - updated_at + - actor + - triggering_actor + - run_attempt + - run_started_at + - display_title + required: + - action + - workflow_run + - since + - workflow_job_run + - environment + - reviewers + - requestor + - repository + - organization + - sender webhook-deployment-status-created: title: deployment_status created event type: object @@ -89602,7 +92562,7 @@ components: - completed_at deployment: title: Deployment - description: The [deployment](https://docs.github.com/rest/reference/deployments#list-deployments). + description: The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). type: object properties: created_at: @@ -90093,7 +93053,7 @@ components: - statuses_url - repository_url deployment_status: - description: The [deployment status](https://docs.github.com/rest/reference/deployments#list-deployment-statuses). + description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). type: object properties: created_at: @@ -94481,6 +97441,8 @@ components: - html_url action: type: string + enum: + - renamed changes: type: object properties: @@ -94576,7 +97538,7 @@ components: - created comment: title: issue comment - description: The [comment](https://docs.github.com/rest/reference/issues#comments) + description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. type: object properties: @@ -94745,11 +97707,11 @@ components: installation: "$ref": "#/components/schemas/simple-installation" issue: - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -95927,7 +98889,7 @@ components: - deleted comment: title: issue comment - description: The [comment](https://docs.github.com/rest/reference/issues#comments) + description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. type: object properties: @@ -96097,11 +99059,11 @@ components: installation: "$ref": "#/components/schemas/simple-installation" issue: - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -97287,7 +100249,7 @@ components: - from comment: title: issue comment - description: The [comment](https://docs.github.com/rest/reference/issues#comments) + description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. type: object properties: @@ -97457,11 +100419,11 @@ components: installation: "$ref": "#/components/schemas/simple-installation" issue: - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -98713,7 +101675,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -99654,11 +102616,11 @@ components: installation: "$ref": "#/components/schemas/simple-installation" issue: - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -100741,7 +103703,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -101677,7 +104639,7 @@ components: issue: allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -103053,7 +106015,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -104029,7 +106991,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -105004,7 +107966,7 @@ components: issue: allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -106087,7 +109049,7 @@ components: issue: allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -107439,7 +110401,7 @@ components: properties: old_issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: - object @@ -108819,7 +111781,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -109758,7 +112720,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -110693,7 +113655,7 @@ components: issue: allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -111773,7 +114735,7 @@ components: properties: new_issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -113160,7 +116122,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -114166,7 +117128,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -115107,7 +118069,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -116082,7 +119044,7 @@ components: issue: allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -117154,7 +120116,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -123368,7 +126330,7 @@ components: type: object properties: build: - description: The [List GitHub Pages builds](https://docs.github.com/rest/reference/repos#list-github-pages-builds) + description: The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. type: object properties: @@ -147540,7 +150502,7 @@ components: - created comment: title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/reference/pulls#comments) + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -150046,7 +153008,7 @@ components: - deleted comment: title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/reference/pulls#comments) + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -152550,7 +155512,7 @@ components: - from comment: title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/reference/pulls#comments) + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -173823,7 +176785,7 @@ components: type: array items: title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/reference/pulls#comments) + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -176227,7 +179189,7 @@ components: type: array items: title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/reference/pulls#comments) + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -185945,7 +188907,7 @@ components: description: An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum - of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/reference/repos#commits) + of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. type: array @@ -187211,6 +190173,8 @@ components: properties: action: type: string + enum: + - updated enterprise: "$ref": "#/components/schemas/enterprise" installation: @@ -187597,7 +190561,7 @@ components: "$ref": "#/components/schemas/organization-simple" release: title: Release - description: The [release](https://docs.github.com/rest/reference/repos/#get-a-release) + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. type: object properties: @@ -187934,7 +190898,7 @@ components: "$ref": "#/components/schemas/organization-simple" release: title: Release - description: The [release](https://docs.github.com/rest/reference/repos/#get-a-release) + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. type: object properties: @@ -188301,7 +191265,7 @@ components: "$ref": "#/components/schemas/organization-simple" release: title: Release - description: The [release](https://docs.github.com/rest/reference/repos/#get-a-release) + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. type: object properties: @@ -188639,7 +191603,7 @@ components: release: allOf: - title: Release - description: The [release](https://docs.github.com/rest/reference/repos/#get-a-release) + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. type: object properties: @@ -189071,7 +192035,7 @@ components: release: allOf: - title: Release - description: The [release](https://docs.github.com/rest/reference/repos/#get-a-release) + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. type: object properties: @@ -189499,7 +192463,7 @@ components: "$ref": "#/components/schemas/organization-simple" release: title: Release - description: The [release](https://docs.github.com/rest/reference/repos/#get-a-release) + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. type: object properties: @@ -189836,7 +192800,7 @@ components: release: allOf: - title: Release - description: The [release](https://docs.github.com/rest/reference/repos/#get-a-release) + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. type: object properties: @@ -190367,6 +193331,8 @@ components: properties: action: type: string + enum: + - sample.collected branch: type: string client_payload: @@ -190559,6 +193525,172 @@ components: - changes - repository - sender + webhook-repository-ruleset-created: + title: repository ruleset created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + repository_ruleset: + "$ref": "#/components/schemas/repository-ruleset" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - repository_ruleset + - sender + webhook-repository-ruleset-deleted: + title: repository ruleset deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + repository_ruleset: + "$ref": "#/components/schemas/repository-ruleset" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - repository_ruleset + - sender + webhook-repository-ruleset-edited: + title: repository ruleset edited event + type: object + properties: + action: + type: string + enum: + - edited + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + repository_ruleset: + "$ref": "#/components/schemas/repository-ruleset" + changes: + type: object + properties: + name: + type: object + properties: + from: + type: string + enforcement: + type: object + properties: + from: + type: string + conditions: + type: object + properties: + added: + type: array + items: + "$ref": "#/components/schemas/repository-ruleset-conditions" + deleted: + type: array + items: + "$ref": "#/components/schemas/repository-ruleset-conditions" + updated: + type: array + items: + type: object + properties: + condition: + "$ref": "#/components/schemas/repository-ruleset-conditions" + changes: + type: object + properties: + condition_type: + type: object + properties: + from: + type: string + target: + type: object + properties: + from: + type: string + include: + type: object + properties: + from: + type: array + items: + type: string + exclude: + type: object + properties: + from: + type: array + items: + type: string + rules: + type: object + properties: + added: + type: array + items: + "$ref": "#/components/schemas/repository-rule" + deleted: + type: array + items: + "$ref": "#/components/schemas/repository-rule" + updated: + type: array + items: + type: object + properties: + rule: + "$ref": "#/components/schemas/repository-rule" + changes: + type: object + properties: + configuration: + type: object + properties: + from: + type: string + rule_type: + type: object + properties: + from: + type: string + pattern: + type: object + properties: + from: + type: string + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - repository_ruleset + - sender webhook-repository-transferred: title: repository transferred event type: object @@ -206474,6 +209606,8 @@ components: - ssh-rsa ABCDEFGHIJKLMNOPQRSTUVWXYZ hooks: - 192.0.2.1 + github_enterprise_importer: + - 192.0.2.1 web: - 192.0.2.1 api: @@ -206821,8 +209955,8 @@ components: advanced_security_enabled_for_new_repositories: false secret_scanning_enabled_for_new_repositories: false secret_scanning_push_protection_enabled_for_new_repositories: false - secret_scanning_push_protection_custom_link: false - secret_scanning_push_protection_custom_link_enabled: https://github.com/octo-org/octo-repo/blob/main/im-blocked.md + secret_scanning_push_protection_custom_link: https://github.com/octo-org/octo-repo/blob/main/im-blocked.md + secret_scanning_push_protection_custom_link_enabled: false actions-cache-usage-org-enterprise: value: total_active_caches_size_in_bytes: 3344284 @@ -207606,10 +210740,10 @@ components: hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks machine: name: standardLinux - display_name: 4 cores, 8 GB RAM, 64 GB storage + display_name: 4 cores, 16 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 8589934592 + memory_in_bytes: 17179869184 cpus: 4 prebuild: false devcontainer_path: ".devcontainer/devcontainer.json" @@ -207741,10 +210875,10 @@ components: hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks machine: name: standardLinux - display_name: 4 cores, 8 GB RAM, 64 GB storage + display_name: 4 cores, 16 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 8589934592 + memory_in_bytes: 17179869184 cpus: 4 prebuild: false devcontainer_path: ".devcontainer/foobar/devcontainer.json" @@ -207876,10 +211010,10 @@ components: hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks machine: name: standardLinux - display_name: 4 cores, 8 GB RAM, 64 GB storage + display_name: 4 cores, 16 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 8589934592 + memory_in_bytes: 17179869184 cpus: 4 prebuild: false devcontainer_path: ".devcontainer.json" @@ -208474,10 +211608,10 @@ components: hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks machine: name: standardLinux - display_name: 4 cores, 8 GB RAM, 64 GB storage + display_name: 4 cores, 16 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 8589934592 + memory_in_bytes: 17179869184 cpus: 4 prebuild: false devcontainer_path: ".devcontainer/devcontainer.json" @@ -209526,6 +212660,285 @@ components: href: https://github.com/organizations/my-org/settings/rules/21 created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' + list-repository-advisories: + value: + - ghsa_id: GHSA-abcd-1234-efgh + cve_id: CVE-2050-00000 + url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh + html_url: https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh + summary: A short summary of the advisory. + description: A detailed description of what the advisory entails. + severity: critical + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + publisher: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + identifiers: + - type: GHSA + value: GHSA-abcd-1234-efgh + - type: CVE + value: CVE-2050-00000 + state: published + created_at: '2020-01-01T00:00:00Z' + updated_at: '2020-01-02T00:00:00Z' + published_at: '2020-01-03T00:00:00Z' + closed_at: + withdrawn_at: + submission: + vulnerabilities: + - package: + ecosystem: pip + name: a-package + vulnerable_version_range: ">= 1.0.0, < 1.0.1" + patched_versions: 1.0.1 + vulnerable_functions: + - function1 + - package: + ecosystem: pip + name: another-package + vulnerable_version_range: ">= 1.0.0, < 1.0.2" + patched_versions: 1.0.2 + vulnerable_functions: + - function2 + cvss: + vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H + score: 9.8 + cwes: + - cwe_id: CWE-123 + name: A CWE + cwe_ids: + - CWE-123 + credits: + - login: octocat + type: analyst + credits_detailed: + - user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + type: analyst + state: accepted + collaborating_users: + - login: octokitten + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + received_events_url: https://api.github.com/users/octokitten/received_events + type: User + site_admin: false + collaborating_teams: + - name: Justice League + id: 1 + node_id: MDQ6VGVhbTE= + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + permission: admin + parent: + - ghsa_id: GHSA-1234-5678-9012 + cve_id: CVE-2051-0000 + url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012 + html_url: https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012 + summary: A short summary of the advisory. + description: A detailed description of what the advisory entails. + severity: low + author: + login: monauser + id: 2 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monauser + html_url: https://github.com/monauser + followers_url: https://api.github.com/users/monauser/followers + following_url: https://api.github.com/users/monauser/following{/other_user} + gists_url: https://api.github.com/users/monauser/gists{/gist_id} + starred_url: https://api.github.com/users/monauser/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monauser/subscriptions + organizations_url: https://api.github.com/users/monauser/orgs + repos_url: https://api.github.com/users/monauser/repos + events_url: https://api.github.com/users/monauser/events{/privacy} + received_events_url: https://api.github.com/users/monauser/received_events + type: User + site_admin: false + publisher: + login: monalisa + id: 3 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: false + identifiers: + - type: GHSA + value: GHSA-1234-5678-9012 + - type: CVE + value: CVE-2051-00000 + state: published + created_at: '2020-01-03T00:00:00Z' + updated_at: '2020-01-04T00:00:00Z' + published_at: '2020-01-04T00:00:00Z' + closed_at: + withdrawn_at: + submission: + - accepted: true + vulnerabilities: + - package: + ecosystem: pip + name: a-package + vulnerable_version_range: ">= 1.0.0, < 1.0.1" + patched_versions: 1.0.1 + vulnerable_functions: + - function1 + - package: + ecosystem: pip + name: another-package + vulnerable_version_range: ">= 1.0.0, < 1.0.2" + patched_versions: 1.0.2 + vulnerable_functions: + - function2 + cvss: + vector_string: AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N + score: 1.6 + cwes: + - cwe_id: CWE-456 + name: A CWE 2.0 + cwe_ids: + - CWE-456 + credits: + - login: monauser + type: reporter + credits_detailed: + - user: + login: monauser + id: 2 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monauser + html_url: https://github.com/monauser + followers_url: https://api.github.com/users/monauser/followers + following_url: https://api.github.com/users/monauser/following{/other_user} + gists_url: https://api.github.com/users/monauser/gists{/gist_id} + starred_url: https://api.github.com/users/monauser/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monauser/subscriptions + organizations_url: https://api.github.com/users/monauser/orgs + repos_url: https://api.github.com/users/monauser/repos + events_url: https://api.github.com/users/monauser/events{/privacy} + received_events_url: https://api.github.com/users/monauser/received_events + type: User + site_admin: false + type: reporter + state: accepted + collaborating_users: + - login: octokitten + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + received_events_url: https://api.github.com/users/octokitten/received_events + type: User + site_admin: false + collaborating_teams: + - name: Justice League + id: 1 + node_id: MDQ6VGVhbTE= + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + permission: admin + parent: actions-billing-usage: value: total_minutes_used: 305 @@ -210415,34 +213828,59 @@ components: resources: core: limit: 5000 - remaining: 4999 - reset: 1372700873 used: 1 + remaining: 4999 + reset: 1691591363 search: limit: 30 - remaining: 18 - reset: 1372697452 used: 12 + remaining: 18 + reset: 1691591091 graphql: limit: 5000 - remaining: 4993 - reset: 1372700389 used: 7 + remaining: 4993 + reset: 1691593228 integration_manifest: limit: 5000 + used: 1 remaining: 4999 - reset: 1551806725 + reset: 1691594631 + source_import: + limit: 100 used: 1 + remaining: 99 + reset: 1691591091 code_scanning_upload: limit: 500 - remaining: 499 - reset: 1551806725 used: 1 + remaining: 499 + reset: 1691594631 + actions_runner_registration: + limit: 10000 + used: 0 + remaining: 10000 + reset: 1691594631 + scim: + limit: 15000 + used: 0 + remaining: 15000 + reset: 1691594631 + dependency_snapshots: + limit: 100 + used: 0 + remaining: 100 + reset: 1691591091 + code_search: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 + used: 1 remaining: 4999 reset: 1372700873 - used: 1 full-repository-default-response: summary: Default response value: @@ -214288,6 +217726,7 @@ components: - python query_suite: default updated_at: '2023-01-19T11:21:34Z' + schedule: weekly code-scanning-default-setup-update: value: state: configured @@ -214444,10 +217883,10 @@ components: hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks machine: name: standardLinux - display_name: 4 cores, 8 GB RAM, 64 GB storage + display_name: 4 cores, 16 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 8589934592 + memory_in_bytes: 17179869184 cpus: 4 prebuild: false devcontainer_path: ".devcontainer/devcontainer.json" @@ -214579,10 +218018,10 @@ components: hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks machine: name: standardLinux - display_name: 4 cores, 8 GB RAM, 64 GB storage + display_name: 4 cores, 16 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 8589934592 + memory_in_bytes: 17179869184 cpus: 4 prebuild: false devcontainer_path: ".devcontainer/devcontainer.json" @@ -214621,16 +218060,16 @@ components: total_count: 2 machines: - name: standardLinux - display_name: 4 cores, 8 GB RAM, 64 GB storage + display_name: 4 cores, 16 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 8589934592 + memory_in_bytes: 17179869184 cpus: 4 - name: premiumLinux - display_name: 8 cores, 16 GB RAM, 64 GB storage + display_name: 8 cores, 32 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 17179869184 + memory_in_bytes: 34359738368 cpus: 8 collaborator-items: value: @@ -221506,285 +224945,6 @@ components: - type: issue_comment details: issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - list-repository-advisories: - value: - - ghsa_id: GHSA-abcd-1234-efgh - cve_id: CVE-2050-00000 - url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh - html_url: https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh - summary: A short summary of the advisory. - description: A detailed description of what the advisory entails. - severity: critical - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - publisher: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - identifiers: - - type: GHSA - value: GHSA-abcd-1234-efgh - - type: CVE - value: CVE-2050-00000 - state: published - created_at: '2020-01-01T00:00:00Z' - updated_at: '2020-01-02T00:00:00Z' - published_at: '2020-01-03T00:00:00Z' - closed_at: - withdrawn_at: - submission: - vulnerabilities: - - package: - ecosystem: pip - name: a-package - vulnerable_version_range: ">= 1.0.0, < 1.0.1" - patched_versions: 1.0.1 - vulnerable_functions: - - function1 - - package: - ecosystem: pip - name: another-package - vulnerable_version_range: ">= 1.0.0, < 1.0.2" - patched_versions: 1.0.2 - vulnerable_functions: - - function2 - cvss: - vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H - score: 9.8 - cwes: - - cwe_id: CWE-123 - name: A CWE - cwe_ids: - - CWE-123 - credits: - - login: octocat - type: analyst - credits_detailed: - - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - type: analyst - state: accepted - collaborating_users: - - login: octokitten - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octokitten_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octokitten - html_url: https://github.com/octokitten - followers_url: https://api.github.com/users/octokitten/followers - following_url: https://api.github.com/users/octokitten/following{/other_user} - gists_url: https://api.github.com/users/octokitten/gists{/gist_id} - starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octokitten/subscriptions - organizations_url: https://api.github.com/users/octokitten/orgs - repos_url: https://api.github.com/users/octokitten/repos - events_url: https://api.github.com/users/octokitten/events{/privacy} - received_events_url: https://api.github.com/users/octokitten/received_events - type: User - site_admin: false - collaborating_teams: - - name: Justice League - id: 1 - node_id: MDQ6VGVhbTE= - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - permission: admin - parent: - - ghsa_id: GHSA-1234-5678-9012 - cve_id: CVE-2051-0000 - url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012 - html_url: https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012 - summary: A short summary of the advisory. - description: A detailed description of what the advisory entails. - severity: low - author: - login: monauser - id: 2 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/monauser - html_url: https://github.com/monauser - followers_url: https://api.github.com/users/monauser/followers - following_url: https://api.github.com/users/monauser/following{/other_user} - gists_url: https://api.github.com/users/monauser/gists{/gist_id} - starred_url: https://api.github.com/users/monauser/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monauser/subscriptions - organizations_url: https://api.github.com/users/monauser/orgs - repos_url: https://api.github.com/users/monauser/repos - events_url: https://api.github.com/users/monauser/events{/privacy} - received_events_url: https://api.github.com/users/monauser/received_events - type: User - site_admin: false - publisher: - login: monalisa - id: 3 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: false - identifiers: - - type: GHSA - value: GHSA-1234-5678-9012 - - type: CVE - value: CVE-2051-00000 - state: published - created_at: '2020-01-03T00:00:00Z' - updated_at: '2020-01-04T00:00:00Z' - published_at: '2020-01-04T00:00:00Z' - closed_at: - withdrawn_at: - submission: - - accepted: true - vulnerabilities: - - package: - ecosystem: pip - name: a-package - vulnerable_version_range: ">= 1.0.0, < 1.0.1" - patched_versions: 1.0.1 - vulnerable_functions: - - function1 - - package: - ecosystem: pip - name: another-package - vulnerable_version_range: ">= 1.0.0, < 1.0.2" - patched_versions: 1.0.2 - vulnerable_functions: - - function2 - cvss: - vector_string: AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N - score: 1.6 - cwes: - - cwe_id: CWE-456 - name: A CWE 2.0 - cwe_ids: - - CWE-456 - credits: - - login: monauser - type: reporter - credits_detailed: - - user: - login: monauser - id: 2 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/monauser - html_url: https://github.com/monauser - followers_url: https://api.github.com/users/monauser/followers - following_url: https://api.github.com/users/monauser/following{/other_user} - gists_url: https://api.github.com/users/monauser/gists{/gist_id} - starred_url: https://api.github.com/users/monauser/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monauser/subscriptions - organizations_url: https://api.github.com/users/monauser/orgs - repos_url: https://api.github.com/users/monauser/repos - events_url: https://api.github.com/users/monauser/events{/privacy} - received_events_url: https://api.github.com/users/monauser/received_events - type: User - site_admin: false - type: reporter - state: accepted - collaborating_users: - - login: octokitten - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octokitten_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octokitten - html_url: https://github.com/octokitten - followers_url: https://api.github.com/users/octokitten/followers - following_url: https://api.github.com/users/octokitten/following{/other_user} - gists_url: https://api.github.com/users/octokitten/gists{/gist_id} - starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octokitten/subscriptions - organizations_url: https://api.github.com/users/octokitten/orgs - repos_url: https://api.github.com/users/octokitten/repos - events_url: https://api.github.com/users/octokitten/events{/privacy} - received_events_url: https://api.github.com/users/octokitten/received_events - type: User - site_admin: false - collaborating_teams: - - name: Justice League - id: 1 - node_id: MDQ6VGVhbTE= - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - permission: admin - parent: repository-advisory: value: ghsa_id: GHSA-abcd-1234-efgh @@ -224543,10 +227703,10 @@ components: watchers: 1 machine: name: standardLinux - display_name: 4 cores, 8 GB RAM, 64 GB storage + display_name: 4 cores, 16 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 8589934592 + memory_in_bytes: 17179869184 cpus: 4 prebuild: false devcontainer_path: ".devcontainer/devcontainer.json" diff --git a/packages/openapi-typescript/examples/github-api.ts b/packages/openapi-typescript/examples/github-api.ts index 489c9685f..6e0c2184a 100644 --- a/packages/openapi-typescript/examples/github-api.ts +++ b/packages/openapi-typescript/examples/github-api.ts @@ -20,7 +20,9 @@ export interface paths { "/advisories": { /** * List global security advisories - * @description List global security advisories and filter using parameters such as ecosystem, GHSA ID, CVE ID, etc. + * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. + * + * 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)." */ get: operations["security-advisories/list-global-advisories"]; }; @@ -116,7 +118,7 @@ export interface paths { get: operations["apps/get-installation"]; /** * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. + * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. * * 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. */ @@ -360,7 +362,7 @@ export interface paths { * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app)" endpoint. + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. * * 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. */ @@ -382,11 +384,17 @@ export interface paths { get: operations["issues/list"]; }; "/licenses": { - /** Get all commonly used licenses */ + /** + * Get all commonly used licenses + * @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)." + */ get: operations["licenses/get-all-commonly-used"]; }; "/licenses/{license}": { - /** Get a license */ + /** + * Get a license + * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + */ get: operations["licenses/get"]; }; "/markdown": { @@ -1929,6 +1937,15 @@ export interface paths { */ get: operations["secret-scanning/list-alerts-for-org"]; }; + "/orgs/{org}/security-advisories": { + /** + * List repository security advisories for an organization + * @description Lists repository security advisories for an organization. + * + * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission. + */ + get: operations["security-advisories/list-org-repository-advisories"]; + }; "/orgs/{org}/security-managers": { /** * List security manager teams @@ -2117,14 +2134,14 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { /** * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ get: operations["reactions/list-for-team-discussion-comment-in-org"]; /** * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ @@ -2135,21 +2152,21 @@ export interface paths { * Delete team discussion comment reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ delete: operations["reactions/delete-for-team-discussion-comment"]; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { /** * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ get: operations["reactions/list-for-team-discussion-in-org"]; /** * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ @@ -2160,7 +2177,7 @@ export interface paths { * Delete team discussion reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ delete: operations["reactions/delete-for-team-discussion"]; }; @@ -2422,6 +2439,17 @@ export interface paths { * Get rate limit status for the authenticated user * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. * + * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/overview/api-versions)." + * * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; @@ -3548,7 +3576,7 @@ export interface paths { * Create a check suite * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. */ post: operations["checks/create-suite"]; }; @@ -3788,7 +3816,7 @@ export interface paths { "/repos/{owner}/{repo}/code-scanning/sarifs": { /** * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. + * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." * * There are two places where you can upload code scanning results. * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." @@ -3801,7 +3829,7 @@ export interface paths { * ``` *
* SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. - * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. + * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * * * | **SARIF data** | **Maximum values** | **Additional limits** | @@ -3969,7 +3997,7 @@ export interface paths { * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * - * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations). + * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). * * **Updating an existing collaborator's permission level** * @@ -4022,7 +4050,7 @@ export interface paths { "/repos/{owner}/{repo}/comments": { /** * List commit comments for a repository - * @description Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + * @description Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). * * Comments are ordered by ascending ID. */ @@ -4039,12 +4067,12 @@ export interface paths { "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { /** * List reactions for a commit comment - * @description List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + * @description List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ get: operations["reactions/list-for-commit-comment"]; /** * Create reaction for a commit comment - * @description Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. + * @description Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ post: operations["reactions/create-for-commit-comment"]; }; @@ -4053,7 +4081,7 @@ export interface paths { * Delete a commit comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ delete: operations["reactions/delete-for-commit-comment"]; }; @@ -4282,13 +4310,13 @@ export interface paths { * @description Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. * - * Files and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for + * Files and symlinks support [a custom media type](https://docs.github.com/rest/overview/media-types) for * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media - * type](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent + * type](https://docs.github.com/rest/overview/media-types) to ensure the content is returned in a consistent * object format. * * **Notes**: - * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees). + * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees * API](https://docs.github.com/rest/git/trees#get-a-tree). * * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. @@ -4322,7 +4350,7 @@ export interface paths { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ put: operations["repos/create-or-update-file-contents"]; /** @@ -4335,7 +4363,7 @@ export interface paths { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; }; @@ -4569,7 +4597,7 @@ export interface paths { * * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[Secrets](/rest/reference/actions#secrets)." + * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -4890,7 +4918,7 @@ export interface paths { "/repos/{owner}/{repo}/git/trees/{tree_sha}": { /** * Get a tree - * @description Returns a single tree using the SHA1 value for that tree. + * @description Returns a single tree using the SHA1 value or ref name for that tree. * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * @@ -4915,28 +4943,28 @@ export interface paths { "/repos/{owner}/{repo}/hooks/{hook_id}": { /** * Get a repository webhook - * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." + * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ get: operations["repos/get-webhook"]; /** Delete a repository webhook */ delete: operations["repos/delete-webhook"]; /** * Update a repository webhook - * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." + * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." */ patch: operations["repos/update-webhook"]; }; "/repos/{owner}/{repo}/hooks/{hook_id}/config": { /** * Get a webhook configuration for a repository - * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." + * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." * * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. */ get: operations["repos/get-webhook-config-for-repo"]; /** * Update a webhook configuration for a repository - * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." + * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." * * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. */ @@ -5190,12 +5218,12 @@ export interface paths { "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { /** * List reactions for an issue comment - * @description List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + * @description List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ get: operations["reactions/list-for-issue-comment"]; /** * Create reaction for an issue comment - * @description Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. + * @description Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ post: operations["reactions/create-for-issue-comment"]; }; @@ -5204,7 +5232,7 @@ export interface paths { * Delete an issue comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ delete: operations["reactions/delete-for-issue-comment"]; }; @@ -5341,12 +5369,12 @@ export interface paths { "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { /** * List reactions for an issue - * @description List the reactions to an [issue](https://docs.github.com/rest/reference/issues). + * @description List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ get: operations["reactions/list-for-issue"]; /** * Create reaction for an issue - * @description Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. + * @description Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ post: operations["reactions/create-for-issue"]; }; @@ -5355,7 +5383,7 @@ export interface paths { * Delete an issue reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * - * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). + * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ delete: operations["reactions/delete-for-issue"]; }; @@ -5420,18 +5448,6 @@ export interface paths { */ get: operations["repos/list-languages"]; }; - "/repos/{owner}/{repo}/lfs": { - /** - * Enable Git LFS for a repository - * @description Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. - */ - put: operations["repos/enable-lfs-for-repo"]; - /** - * Disable Git LFS for a repository - * @description Disables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. - */ - delete: operations["repos/disable-lfs-for-repo"]; - }; "/repos/{owner}/{repo}/license": { /** * Get the license for a repository @@ -5581,6 +5597,18 @@ export interface paths { */ get: operations["repos/get-pages-health-check"]; }; + "/repos/{owner}/{repo}/private-vulnerability-reporting": { + /** + * Enable private vulnerability reporting for a repository + * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." + */ + put: operations["repos/enable-private-vulnerability-reporting"]; + /** + * Disable private vulnerability reporting for a repository + * @description Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". + */ + delete: operations["repos/disable-private-vulnerability-reporting"]; + }; "/repos/{owner}/{repo}/projects": { /** * List repository projects @@ -5636,12 +5664,12 @@ export interface paths { "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + * @description List the reactions to a [pull request review comment](https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; /** * Create reaction for a pull request review comment - * @description Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. + * @description Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ post: operations["reactions/create-for-pull-request-review-comment"]; }; @@ -5650,7 +5678,7 @@ export interface paths { * Delete a pull request comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * - * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ delete: operations["reactions/delete-for-pull-request-comment"]; }; @@ -5661,7 +5689,7 @@ export interface paths { * * Lists details of a pull request by providing its number. * - * When you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. * @@ -5724,7 +5752,7 @@ export interface paths { "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { /** * List commits on a pull request - * @description Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. + * @description Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) endpoint. */ get: operations["pulls/list-commits"]; }; @@ -5776,7 +5804,7 @@ export interface paths { * Create a review for a pull request * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * - * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request)." + * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * * **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. * @@ -5811,14 +5839,14 @@ export interface paths { "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { /** * Dismiss a review for a pull request - * @description **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. + * @description **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ put: operations["pulls/dismiss-review"]; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { /** * Submit a review for a pull request - * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls#create-a-review-for-a-pull-request)." + * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." */ post: operations["pulls/submit-review"]; }; @@ -5834,7 +5862,7 @@ export interface paths { * Get a repository README * @description Gets the preferred README for a repository. * - * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. */ get: operations["repos/get-readme"]; }; @@ -5843,7 +5871,7 @@ export interface paths { * Get a repository README for a directory * @description Gets the README from a repository directory. * - * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. */ get: operations["repos/get-readme-in-directory"]; }; @@ -5880,7 +5908,7 @@ export interface paths { "/repos/{owner}/{repo}/releases/generate-notes": { /** * Generate release notes content for a release - * @description Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. + * @description Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ post: operations["repos/generate-release-notes"]; }; @@ -5937,7 +5965,7 @@ export interface paths { * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. * * **Notes:** - * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List assets for a release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)" + * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)" * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. @@ -5947,12 +5975,12 @@ export interface paths { "/repos/{owner}/{repo}/releases/{release_id}/reactions": { /** * List reactions for a release - * @description List the reactions to a [release](https://docs.github.com/rest/reference/repos#releases). + * @description List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ get: operations["reactions/list-for-release"]; /** * Create reaction for a release - * @description Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. + * @description Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ post: operations["reactions/create-for-release"]; }; @@ -5961,7 +5989,7 @@ export interface paths { * Delete a release reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * - * Delete a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). + * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ delete: operations["reactions/delete-for-release"]; }; @@ -6094,6 +6122,19 @@ export interface paths { */ patch: operations["security-advisories/update-repository-advisory"]; }; + "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": { + /** + * Request a CVE for a repository security advisory + * @description If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." + * + * You may request a CVE for public repositories, but cannot do so for private repositories. + * + * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + * + * In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + */ + post: operations["security-advisories/create-repository-advisory-cve-request"]; + }; "/repos/{owner}/{repo}/stargazers": { /** * List stargazers @@ -6450,7 +6491,7 @@ export interface paths { * Search code * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: * @@ -6477,7 +6518,7 @@ export interface paths { * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match - * metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: * @@ -6491,7 +6532,7 @@ export interface paths { * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. * @@ -6508,7 +6549,7 @@ export interface paths { * Search labels * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: * @@ -6523,7 +6564,7 @@ export interface paths { * Search repositories * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: * @@ -6538,7 +6579,7 @@ export interface paths { * Search topics * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: * @@ -6553,7 +6594,7 @@ export interface paths { * Search users * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you're looking for a list of popular users, you might try this query: * @@ -6691,7 +6732,7 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ get: operations["reactions/list-for-team-discussion-comment-legacy"]; /** @@ -6699,7 +6740,7 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. */ post: operations["reactions/create-for-team-discussion-comment-legacy"]; }; @@ -6709,7 +6750,7 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ get: operations["reactions/list-for-team-discussion-legacy"]; /** @@ -6717,7 +6758,7 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. */ post: operations["reactions/create-for-team-discussion-legacy"]; }; @@ -6878,7 +6919,7 @@ export interface paths { * @deprecated * @description **Note**: Repositories inherited through a parent team will also be checked. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-repository) endpoint. + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ @@ -6886,7 +6927,7 @@ export interface paths { /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. + * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -6896,7 +6937,7 @@ export interface paths { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. + * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -7684,7 +7725,7 @@ export interface paths { * * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". */ get: operations["users/get-by-username"]; }; @@ -8188,7 +8229,8 @@ export interface components { github_reviewed_at: string | null; /** * Format: date-time - * @description The date and time of when the advisory was published in the National Vulnerability Database, in ISO 8601 format. + * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. + * This field is only populated when the advisory is imported from the National Vulnerability Database. */ nvd_published_at: string | null; /** @@ -10962,6 +11004,12 @@ export interface components { * ] */ hooks?: string[]; + /** + * @example [ + * "192.0.2.1" + * ] + */ + github_enterprise_importer?: string[]; /** * @example [ * "192.0.2.1" @@ -11932,7 +11980,7 @@ export interface components { name: string; /** * @description The display name of the machine includes cores, memory, and storage. - * @example 4 cores, 8 GB RAM, 64 GB storage + * @example 4 cores, 16 GB RAM, 64 GB storage */ display_name: string; /** @@ -11947,7 +11995,7 @@ export interface components { storage_in_bytes: number; /** * @description How much memory is available to the codespace. - * @example 8589934592 + * @example 17179869184 */ memory_in_bytes: number; /** @@ -13423,6 +13471,128 @@ export interface components { /** Format: date-time */ updated_at?: string; }; + /** @description A product affected by the vulnerability detailed in a repository security advisory. */ + "repository-advisory-vulnerability": { + /** @description The name of the package affected by the vulnerability. */ + package: ({ + ecosystem: components["schemas"]["security-advisory-ecosystems"]; + /** @description The unique package name within its ecosystem. */ + name: string | null; + }) | null; + /** @description The range of the package versions affected by the vulnerability. */ + vulnerable_version_range: string | null; + /** @description The package version(s) that resolve the vulnerability. */ + patched_versions: string | null; + /** @description The functions in the package that are affected. */ + vulnerable_functions: string[] | null; + }; + /** @description A credit given to a user for a repository security advisory. */ + "repository-advisory-credit": { + user: components["schemas"]["simple-user"]; + type: components["schemas"]["security-advisory-credit-types"]; + /** + * @description The state of the user's acceptance of the credit. + * @enum {string} + */ + state: "accepted" | "declined" | "pending"; + }; + /** @description A repository security advisory. */ + "repository-advisory": { + /** @description The GitHub Security Advisory ID. */ + ghsa_id: string; + /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + cve_id: string | null; + /** @description The API URL for the advisory. */ + url: string; + /** + * Format: uri + * @description The URL for the advisory. + */ + html_url: string; + /** @description A short summary of the advisory. */ + summary: string; + /** @description A detailed description of what the advisory entails. */ + description: string | null; + /** + * @description The severity of the advisory. + * @enum {string|null} + */ + severity: "critical" | "high" | "medium" | "low" | null; + /** @description The author of the advisory. */ + author: components["schemas"]["simple-user"] | null; + /** @description The publisher of the advisory. */ + publisher: components["schemas"]["simple-user"] | null; + identifiers: readonly ({ + /** + * @description The type of identifier. + * @enum {string} + */ + type: "CVE" | "GHSA"; + /** @description The identifier value. */ + value: string; + })[]; + /** + * @description The state of the advisory. + * @enum {string} + */ + state: "published" | "closed" | "withdrawn" | "draft" | "triage"; + /** + * Format: date-time + * @description The date and time of when the advisory was created, in ISO 8601 format. + */ + created_at: string | null; + /** + * Format: date-time + * @description The date and time of when the advisory was last updated, in ISO 8601 format. + */ + updated_at: string | null; + /** + * Format: date-time + * @description The date and time of when the advisory was published, in ISO 8601 format. + */ + published_at: string | null; + /** + * Format: date-time + * @description The date and time of when the advisory was closed, in ISO 8601 format. + */ + closed_at: string | null; + /** + * Format: date-time + * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + */ + withdrawn_at: string | null; + submission: { + /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ + readonly accepted: boolean; + } | null; + vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null; + cvss: ({ + /** @description The CVSS vector. */ + vector_string: string | null; + /** @description The CVSS score. */ + score: number | null; + }) | null; + cwes: readonly { + /** @description The Common Weakness Enumeration (CWE) identifier. */ + cwe_id: string; + /** @description The name of the CWE. */ + name: string; + }[] | null; + /** @description A list of only the CWE IDs. */ + cwe_ids: string[] | null; + credits: { + /** @description The username of the user credited. */ + login?: string; + type?: components["schemas"]["security-advisory-credit-types"]; + }[] | null; + credits_detailed: readonly components["schemas"]["repository-advisory-credit"][] | null; + /** @description A list of users that collaborate on the advisory. */ + collaborating_users: components["schemas"]["simple-user"][] | null; + /** @description A list of teams that collaborate on the advisory. */ + collaborating_teams: components["schemas"]["team"][] | null; + /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ + private_fork: components["schemas"]["simple-repository"] | null; + }; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. @@ -17009,6 +17179,11 @@ export interface components { * @example 2023-12-06T14:20:20.000Z */ updated_at?: string | null; + /** + * @description The frequency of the periodic analysis. + * @enum {string|null} + */ + schedule?: "weekly" | null; }; /** @description Configuration for code scanning default setup. */ "code-scanning-default-setup-update": { @@ -17117,7 +17292,7 @@ export interface components { name: string; /** * @description The display name of the machine includes cores, memory, and storage. - * @example 4 cores, 8 GB RAM, 64 GB storage + * @example 4 cores, 16 GB RAM, 64 GB storage */ display_name: string; /** @@ -17132,7 +17307,7 @@ export interface components { storage_in_bytes: number; /** * @description How much memory is available to the codespace. - * @example 8589934592 + * @example 17179869184 */ memory_in_bytes: number; /** @@ -21089,128 +21264,6 @@ export interface components { type: "commit" | "issue_title" | "issue_body" | "issue_comment"; details: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"]; }; - /** @description A product affected by the vulnerability detailed in a repository security advisory. */ - "repository-advisory-vulnerability": { - /** @description The name of the package affected by the vulnerability. */ - package: ({ - ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ - name: string | null; - }) | null; - /** @description The range of the package versions affected by the vulnerability. */ - vulnerable_version_range: string | null; - /** @description The package version(s) that resolve the vulnerability. */ - patched_versions: string | null; - /** @description The functions in the package that are affected. */ - vulnerable_functions: string[] | null; - }; - /** @description A credit given to a user for a repository security advisory. */ - "repository-advisory-credit": { - user: components["schemas"]["simple-user"]; - type: components["schemas"]["security-advisory-credit-types"]; - /** - * @description The state of the user's acceptance of the credit. - * @enum {string} - */ - state: "accepted" | "declined" | "pending"; - }; - /** @description A repository security advisory. */ - "repository-advisory": { - /** @description The GitHub Security Advisory ID. */ - ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - cve_id: string | null; - /** @description The API URL for the advisory. */ - url: string; - /** - * Format: uri - * @description The URL for the advisory. - */ - html_url: string; - /** @description A short summary of the advisory. */ - summary: string; - /** @description A detailed description of what the advisory entails. */ - description: string | null; - /** - * @description The severity of the advisory. - * @enum {string|null} - */ - severity: "critical" | "high" | "medium" | "low" | null; - /** @description The author of the advisory. */ - author: components["schemas"]["simple-user"] | null; - /** @description The publisher of the advisory. */ - publisher: components["schemas"]["simple-user"] | null; - identifiers: readonly ({ - /** - * @description The type of identifier. - * @enum {string} - */ - type: "CVE" | "GHSA"; - /** @description The identifier value. */ - value: string; - })[]; - /** - * @description The state of the advisory. - * @enum {string} - */ - state: "published" | "closed" | "withdrawn" | "draft" | "triage"; - /** - * Format: date-time - * @description The date and time of when the advisory was created, in ISO 8601 format. - */ - created_at: string | null; - /** - * Format: date-time - * @description The date and time of when the advisory was last updated, in ISO 8601 format. - */ - updated_at: string | null; - /** - * Format: date-time - * @description The date and time of when the advisory was published, in ISO 8601 format. - */ - published_at: string | null; - /** - * Format: date-time - * @description The date and time of when the advisory was closed, in ISO 8601 format. - */ - closed_at: string | null; - /** - * Format: date-time - * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. - */ - withdrawn_at: string | null; - submission: { - /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ - readonly accepted: boolean; - } | null; - vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null; - cvss: ({ - /** @description The CVSS vector. */ - vector_string: string | null; - /** @description The CVSS score. */ - score: number | null; - }) | null; - cwes: readonly { - /** @description The Common Weakness Enumeration (CWE) identifier. */ - cwe_id: string; - /** @description The name of the CWE. */ - name: string; - }[] | null; - /** @description A list of only the CWE IDs. */ - cwe_ids: string[] | null; - credits: { - /** @description The username of the user credited. */ - login?: string; - type?: components["schemas"]["security-advisory-credit-types"]; - }[] | null; - credits_detailed: readonly components["schemas"]["repository-advisory-credit"][] | null; - /** @description A list of users that collaborate on the advisory. */ - collaborating_users: components["schemas"]["simple-user"][] | null; - /** @description A list of teams that collaborate on the advisory. */ - collaborating_teams: components["schemas"]["team"][] | null; - /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ - private_fork: components["schemas"]["simple-repository"] | null; - }; "repository-advisory-create": { /** @description A short summary of the advisory. */ summary: string; @@ -23191,7 +23244,7 @@ export interface components { "webhook-check-suite-completed": { /** @enum {string} */ action: "completed"; - /** @description The [check_suite](https://docs.github.com/rest/reference/checks#suites). */ + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { after: string | null; /** @@ -23432,7 +23485,7 @@ export interface components { "webhook-check-suite-requested": { /** @enum {string} */ action: "requested"; - /** @description The [check_suite](https://docs.github.com/rest/reference/checks#suites). */ + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { after: string | null; /** @@ -23673,7 +23726,7 @@ export interface components { "webhook-check-suite-rerequested": { /** @enum {string} */ action: "rerequested"; - /** @description The [check_suite](https://docs.github.com/rest/reference/checks#suites). */ + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { after: string | null; /** @@ -24593,7 +24646,7 @@ export interface components { * @enum {string} */ action: "created"; - /** @description The [commit comment](https://docs.github.com/rest/reference/repos#get-a-commit-comment) resource. */ + /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ comment: { /** * AuthorAssociation @@ -24800,7 +24853,7 @@ export interface components { action: "created"; enterprise?: components["schemas"]["enterprise"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [`deploy key`](https://docs.github.com/rest/reference/deployments#get-a-deploy-key) resource. */ + /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ key: { added_by?: string | null; created_at: string; @@ -24823,7 +24876,7 @@ export interface components { action: "deleted"; enterprise?: components["schemas"]["enterprise"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [`deploy key`](https://docs.github.com/rest/reference/deployments#get-a-deploy-key) resource. */ + /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ key: { added_by?: string | null; created_at: string; @@ -24846,7 +24899,7 @@ export interface components { action: "created"; /** * Deployment - * @description The [deployment](https://docs.github.com/rest/reference/deployments#list-deployments). + * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). */ deployment: { created_at: string; @@ -25364,6 +25417,1129 @@ export interface components { installation?: components["schemas"]["simple-installation"]; sender?: components["schemas"]["simple-user"]; }; + "webhook-deployment-review-approved": { + /** @enum {string} */ + action: "approved"; + approver?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + comment?: string; + enterprise?: components["schemas"]["enterprise"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple"]; + repository: components["schemas"]["repository"]; + reviewers?: ({ + /** User */ + reviewer?: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + /** @enum {string} */ + type?: "User"; + })[]; + sender: components["schemas"]["simple-user"]; + since: string; + workflow_job_run?: { + conclusion: Record | null; + created_at: string; + environment: string; + html_url: string; + id: number; + name: Record | null; + status: string; + updated_at: string; + }; + workflow_job_runs?: ({ + conclusion?: Record | null; + created_at?: string; + environment?: string; + html_url?: string; + id?: number; + name?: string | null; + status?: string; + updated_at?: string; + })[]; + /** Deployment Workflow Run */ + workflow_run: ({ + /** User */ + actor: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; + /** @enum {string|null} */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + created_at: string; + display_title: string; + event: string; + head_branch: string; + head_commit?: Record | null; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + id: number; + number: number; + /** Format: uri */ + url: string; + }[]; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; + }[] | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; + /** Format: date-time */ + run_started_at: string; + /** @enum {string} */ + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + /** User */ + triggering_actor: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + workflow_id: number; + workflow_url?: string; + }) | null; + }; + "webhook-deployment-review-rejected": { + /** @enum {string} */ + action: "rejected"; + approver?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + comment?: string; + enterprise?: components["schemas"]["enterprise"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple"]; + repository: components["schemas"]["repository"]; + reviewers?: ({ + /** User */ + reviewer?: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + /** @enum {string} */ + type?: "User"; + })[]; + sender: components["schemas"]["simple-user"]; + since: string; + workflow_job_run?: { + conclusion: Record | null; + created_at: string; + environment: string; + html_url: string; + id: number; + name: Record | null; + status: string; + updated_at: string; + }; + workflow_job_runs?: ({ + conclusion?: string | null; + created_at?: string; + environment?: string; + html_url?: string; + id?: number; + name?: string | null; + status?: string; + updated_at?: string; + })[]; + /** Deployment Workflow Run */ + workflow_run: ({ + /** User */ + actor: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; + /** @enum {string|null} */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + created_at: string; + event: string; + head_branch: string; + head_commit?: Record | null; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + id: number; + number: number; + /** Format: uri */ + url: string; + }[]; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; + }[] | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; + /** Format: date-time */ + run_started_at: string; + /** @enum {string} */ + status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; + /** User */ + triggering_actor: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + workflow_id: number; + workflow_url?: string; + display_title: string; + }) | null; + }; + "webhook-deployment-review-requested": { + /** @enum {string} */ + action: "requested"; + enterprise?: components["schemas"]["enterprise"]; + environment: string; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple"]; + repository: components["schemas"]["repository"]; + /** User */ + requestor: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + reviewers: ({ + /** User */ + reviewer?: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login?: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + /** @enum {string} */ + type?: "User" | "Team"; + })[]; + sender: components["schemas"]["simple-user"]; + since: string; + workflow_job_run: { + conclusion: Record | null; + created_at: string; + environment: string; + html_url: string; + id: number; + name: string | null; + status: string; + updated_at: string; + }; + /** Deployment Workflow Run */ + workflow_run: ({ + /** User */ + actor: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; + /** @enum {string|null} */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + created_at: string; + event: string; + head_branch: string; + head_commit?: Record | null; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + id: number; + number: number; + /** Format: uri */ + url: string; + }[]; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; + }[] | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; + /** Format: date-time */ + run_started_at: string; + /** @enum {string} */ + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + /** User */ + triggering_actor: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + }) | null; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + workflow_id: number; + workflow_url?: string; + display_title: string; + }) | null; + }; /** deployment_status created event */ "webhook-deployment-status-created": { /** @enum {string} */ @@ -25400,7 +26576,7 @@ export interface components { }) | null; /** * Deployment - * @description The [deployment](https://docs.github.com/rest/reference/deployments#list-deployments). + * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). */ deployment: { created_at: string; @@ -25594,7 +26770,7 @@ export interface components { /** Format: uri */ url: string; }; - /** @description The [deployment status](https://docs.github.com/rest/reference/deployments#list-deployment-statuses). */ + /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ deployment_status: { created_at: string; /** User */ @@ -27589,7 +28765,8 @@ export interface components { url?: string; website_url?: Record | null; }; - action: string; + /** @enum {string} */ + action: "renamed"; changes: { login?: { from: string; @@ -27633,7 +28810,7 @@ export interface components { action: "created"; /** * issue comment - * @description The [comment](https://docs.github.com/rest/reference/issues#comments) itself. + * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. */ comment: { /** @@ -27718,7 +28895,7 @@ export interface components { }; enterprise?: components["schemas"]["enterprise"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/reference/issues) the comment belongs to. */ + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: ({ /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -28247,7 +29424,7 @@ export interface components { action: "deleted"; /** * issue comment - * @description The [comment](https://docs.github.com/rest/reference/issues#comments) itself. + * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. */ comment: { /** @@ -28332,7 +29509,7 @@ export interface components { }; enterprise?: components["schemas"]["enterprise"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/reference/issues) the comment belongs to. */ + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: ({ /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -28868,7 +30045,7 @@ export interface components { }; /** * issue comment - * @description The [comment](https://docs.github.com/rest/reference/issues#comments) itself. + * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. */ comment: { /** @@ -28953,7 +30130,7 @@ export interface components { }; enterprise?: components["schemas"]["enterprise"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/reference/issues) the comment belongs to. */ + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: ({ /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -29524,7 +30701,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -29945,7 +31122,7 @@ export interface components { action: "closed"; enterprise?: components["schemas"]["enterprise"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/reference/issues) itself. */ + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: ({ /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -30423,7 +31600,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -31469,7 +32646,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -31905,7 +33082,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -33431,7 +34608,7 @@ export interface components { changes?: { /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ old_issue: ({ /** @enum {string|null} */ @@ -34079,7 +35256,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -34499,7 +35676,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -35393,7 +36570,7 @@ export interface components { changes: { /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ new_issue: { /** @enum {string|null} */ @@ -36048,7 +37225,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -36508,7 +37685,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -36928,7 +38105,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -37839,7 +39016,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/rest/reference/issues) itself. + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -40612,7 +41789,7 @@ export interface components { }; /** page_build event */ "webhook-page-build": { - /** @description The [List GitHub Pages builds](https://docs.github.com/rest/reference/repos#list-github-pages-builds) itself. */ + /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ build: { commit: string | null; created_at: string; @@ -52973,7 +54150,7 @@ export interface components { action: "created"; /** * Pull Request Review Comment - * @description The [comment](https://docs.github.com/rest/reference/pulls#comments) itself. + * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ comment: { _links: { @@ -54245,7 +55422,7 @@ export interface components { action: "deleted"; /** * Pull Request Review Comment - * @description The [comment](https://docs.github.com/rest/reference/pulls#comments) itself. + * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ comment: { _links: { @@ -55524,7 +56701,7 @@ export interface components { }; /** * Pull Request Review Comment - * @description The [comment](https://docs.github.com/rest/reference/pulls#comments) itself. + * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ comment: { _links: { @@ -72426,7 +73603,7 @@ export interface components { base_ref: string | null; /** @description The SHA of the most recent commit on `ref` before the push. */ before: string; - /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/reference/repos#commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. */ + /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. */ commits: ({ /** @description An array of files added in the commit. */ added?: string[]; @@ -72995,7 +74172,8 @@ export interface components { sender: components["schemas"]["simple-user"]; }; "webhook-registry-package-updated": { - action: string; + /** @enum {string} */ + action: "updated"; enterprise?: components["schemas"]["enterprise"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple"]; @@ -73135,7 +74313,7 @@ export interface components { organization?: components["schemas"]["organization-simple"]; /** * Release - * @description The [release](https://docs.github.com/rest/reference/repos/#get-a-release) object. + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ release: { assets: ({ @@ -73292,7 +74470,7 @@ export interface components { organization?: components["schemas"]["organization-simple"]; /** * Release - * @description The [release](https://docs.github.com/rest/reference/repos/#get-a-release) object. + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ release: { assets: ({ @@ -73463,7 +74641,7 @@ export interface components { organization?: components["schemas"]["organization-simple"]; /** * Release - * @description The [release](https://docs.github.com/rest/reference/repos/#get-a-release) object. + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ release: { assets: ({ @@ -74007,7 +75185,7 @@ export interface components { organization?: components["schemas"]["organization-simple"]; /** * Release - * @description The [release](https://docs.github.com/rest/reference/repos/#get-a-release) object. + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ release: { assets: ({ @@ -74400,7 +75578,8 @@ export interface components { }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { - action: string; + /** @enum {string} */ + action: "sample.collected"; branch: string; client_payload: { [key: string]: unknown; @@ -74482,6 +75661,86 @@ export interface components { repository: components["schemas"]["repository"]; sender: components["schemas"]["simple-user"]; }; + /** repository ruleset created event */ + "webhook-repository-ruleset-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple"]; + repository?: components["schemas"]["repository"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + sender: components["schemas"]["simple-user"]; + }; + /** repository ruleset deleted event */ + "webhook-repository-ruleset-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple"]; + repository?: components["schemas"]["repository"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + sender: components["schemas"]["simple-user"]; + }; + /** repository ruleset edited event */ + "webhook-repository-ruleset-edited": { + /** @enum {string} */ + action: "edited"; + enterprise?: components["schemas"]["enterprise"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple"]; + repository?: components["schemas"]["repository"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + changes?: { + name?: { + from?: string; + }; + enforcement?: { + from?: string; + }; + conditions?: { + added?: components["schemas"]["repository-ruleset-conditions"][]; + deleted?: components["schemas"]["repository-ruleset-conditions"][]; + updated?: { + condition?: components["schemas"]["repository-ruleset-conditions"]; + changes?: { + condition_type?: { + from?: string; + }; + target?: { + from?: string; + }; + include?: { + from?: string[]; + }; + exclude?: { + from?: string[]; + }; + }; + }[]; + }; + rules?: { + added?: components["schemas"]["repository-rule"][]; + deleted?: components["schemas"]["repository-rule"][]; + updated?: { + rule?: components["schemas"]["repository-rule"]; + changes?: { + configuration?: { + from?: string; + }; + rule_type?: { + from?: string; + }; + pattern?: { + from?: string; + }; + }; + }[]; + }; + }; + sender: components["schemas"]["simple-user"]; + }; /** repository transferred event */ "webhook-repository-transferred": { /** @enum {string} */ @@ -80469,7 +81728,9 @@ export interface operations { }; /** * List global security advisories - * @description List global security advisories and filter using parameters such as ecosystem, GHSA ID, CVE ID, etc. + * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. + * + * 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: { @@ -80484,11 +81745,20 @@ export interface operations { ecosystem?: "actions" | "composer" | "erlang" | "go" | "maven" | "npm" | "nuget" | "other" | "pip" | "pub" | "rubygems" | "rust"; /** @description If specified, only advisories with these severities will be returned. */ severity?: "unknown" | "low" | "medium" | "high" | "critical"; - /** @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. */ + /** + * @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. + * + * Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` + */ cwes?: string | string[]; /** @description Whether to only return advisories that have been withdrawn. */ is_withdrawn?: boolean; - /** @description If specified, return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. */ + /** + * @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. + * If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. + * + * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` + */ affects?: string | string[]; /** * @description If specified, only return advisories that were published on a date or date range. @@ -80777,7 +82047,7 @@ export interface operations { }; /** * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. + * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. * * 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. */ @@ -81814,7 +83084,7 @@ export interface operations { * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app)" endpoint. + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. * * 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. */ @@ -81873,7 +83143,10 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Get all commonly used licenses */ + /** + * Get all commonly used licenses + * @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: { query?: { @@ -81892,7 +83165,10 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** Get a license */ + /** + * Get a license + * @description Gets information about a specific license. 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": { parameters: { path: { @@ -85045,7 +86321,7 @@ export interface operations { "application/json": { /** @description Must be passed as "web". */ name: string; - /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#create-hook-config-params). */ + /** @description Key/value pairs to provide settings for this webhook. */ config: { url: components["schemas"]["webhook-config-url"]; content_type?: components["schemas"]["webhook-config-content-type"]; @@ -85137,7 +86413,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#update-hook-config-params). */ + /** @description Key/value pairs to provide settings for this webhook. */ config?: { url: components["schemas"]["webhook-config-url"]; content_type?: components["schemas"]["webhook-config-content-type"]; @@ -87243,6 +88519,40 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * List repository security advisories for an organization + * @description Lists repository security advisories for an organization. + * + * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission. + */ + "security-advisories/list-org-repository-advisories": { + parameters: { + query?: { + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: "created" | "updated" | "published"; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + /** @description The number of advisories to return per page. */ + per_page?: number; + /** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */ + state?: "triage" | "draft" | "published" | "closed"; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-advisory"][]; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List security manager teams * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." @@ -87878,14 +89188,14 @@ export interface operations { }; /** * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ "reactions/list-for-team-discussion-comment-in-org": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -87911,7 +89221,7 @@ export interface operations { }; /** * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ @@ -87928,7 +89238,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. * @enum {string} */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; @@ -87954,7 +89264,7 @@ export interface operations { * Delete team discussion comment reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ "reactions/delete-for-team-discussion-comment": { parameters: { @@ -87975,14 +89285,14 @@ export interface operations { }; /** * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ "reactions/list-for-team-discussion-in-org": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -88007,7 +89317,7 @@ export interface operations { }; /** * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ @@ -88023,7 +89333,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. * @enum {string} */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; @@ -88049,7 +89359,7 @@ export interface operations { * Delete team discussion reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ "reactions/delete-for-team-discussion": { parameters: { @@ -89204,6 +90514,17 @@ export interface operations { * Get rate limit status for the authenticated user * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. * + * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/overview/api-versions)." + * * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ "rate-limit/get": { @@ -92957,7 +94278,7 @@ export interface operations { caption?: string; }[]; }; - /** @description Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ + /** @description Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ actions?: { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ label: string; @@ -93095,7 +94416,7 @@ export interface operations { caption?: string; }[]; }; - /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ + /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ actions?: { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ label: string; @@ -93194,7 +94515,7 @@ export interface operations { * Create a check suite * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. */ "checks/create-suite": { parameters: { @@ -93801,7 +95122,7 @@ export interface operations { }; /** * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. + * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." * * There are two places where you can upload code scanning results. * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." @@ -93814,7 +95135,7 @@ export interface operations { * ``` *
* SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. - * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. + * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * * * | **SARIF data** | **Maximum values** | **Additional limits** | @@ -94378,7 +95699,7 @@ export interface operations { * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * - * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations). + * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). * * **Updating an existing collaborator's permission level** * @@ -94498,7 +95819,7 @@ export interface operations { }; /** * List commit comments for a repository - * @description Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + * @description Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). * * Comments are ordered by ascending ID. */ @@ -94590,12 +95911,12 @@ export interface operations { }; /** * List reactions for a commit comment - * @description List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + * @description List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ "reactions/list-for-commit-comment": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -94621,7 +95942,7 @@ export interface operations { }; /** * Create reaction for a commit comment - * @description Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. + * @description Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ "reactions/create-for-commit-comment": { parameters: { @@ -94635,7 +95956,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the commit comment. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment. * @enum {string} */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; @@ -94662,7 +95983,7 @@ export interface operations { * Delete a commit comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ "reactions/delete-for-commit-comment": { parameters: { @@ -95189,13 +96510,13 @@ export interface operations { * @description Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. * - * Files and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for + * Files and symlinks support [a custom media type](https://docs.github.com/rest/overview/media-types) for * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media - * type](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent + * type](https://docs.github.com/rest/overview/media-types) to ensure the content is returned in a consistent * object format. * * **Notes**: - * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees). + * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees * API](https://docs.github.com/rest/git/trees#get-a-tree). * * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. @@ -95254,7 +96575,7 @@ export interface operations { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ "repos/create-or-update-file-contents": { parameters: { @@ -95325,7 +96646,7 @@ export interface operations { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ "repos/delete-file": { parameters: { @@ -96181,7 +97502,7 @@ export interface operations { * * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[Secrets](/rest/reference/actions#secrets)." + * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -96948,8 +98269,8 @@ export interface operations { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; /** - * @description The name of the fully qualified reference to update. For example, `refs/heads/master`. If the value doesn't start with `refs` and have at least two slashes, it will be rejected. - * @example refs/head/master + * @description The name of the reference to update (for example, `heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/featureA */ ref: string; }; @@ -97180,7 +98501,7 @@ export interface operations { }; /** * Get a tree - * @description Returns a single tree using the SHA1 value for that tree. + * @description Returns a single tree using the SHA1 value or ref name for that tree. * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * @@ -97196,6 +98517,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; + /** @description The SHA1 value or ref (branch or tag) name of the tree. */ tree_sha: string; }; }; @@ -97255,7 +98577,7 @@ export interface operations { "application/json": { /** @description Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. */ name?: string; - /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */ + /** @description Key/value pairs to provide settings for this webhook. */ config?: { url?: components["schemas"]["webhook-config-url"]; content_type?: components["schemas"]["webhook-config-content-type"]; @@ -97299,7 +98621,7 @@ export interface operations { }; /** * Get a repository webhook - * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." + * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ "repos/get-webhook": { parameters: { @@ -97338,7 +98660,7 @@ export interface operations { }; /** * Update a repository webhook - * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." + * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." */ "repos/update-webhook": { parameters: { @@ -97351,7 +98673,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */ + /** @description Key/value pairs to provide settings for this webhook. */ config?: { url: components["schemas"]["webhook-config-url"]; content_type?: components["schemas"]["webhook-config-content-type"]; @@ -97394,7 +98716,7 @@ export interface operations { }; /** * Get a webhook configuration for a repository - * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." + * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." * * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. */ @@ -97417,7 +98739,7 @@ export interface operations { }; /** * Update a webhook configuration for a repository - * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." + * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." * * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. */ @@ -98256,12 +99578,12 @@ export interface operations { }; /** * List reactions for an issue comment - * @description List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + * @description List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ "reactions/list-for-issue-comment": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -98287,7 +99609,7 @@ export interface operations { }; /** * Create reaction for an issue comment - * @description Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. + * @description Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ "reactions/create-for-issue-comment": { parameters: { @@ -98301,7 +99623,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue comment. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment. * @enum {string} */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; @@ -98328,7 +99650,7 @@ export interface operations { * Delete an issue comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ "reactions/delete-for-issue-comment": { parameters: { @@ -98906,12 +100228,12 @@ export interface operations { }; /** * List reactions for an issue - * @description List the reactions to an [issue](https://docs.github.com/rest/reference/issues). + * @description List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ "reactions/list-for-issue": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -98938,7 +100260,7 @@ export interface operations { }; /** * Create reaction for an issue - * @description Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. + * @description Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ "reactions/create-for-issue": { parameters: { @@ -98952,7 +100274,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue. * @enum {string} */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; @@ -98979,7 +100301,7 @@ export interface operations { * Delete an issue reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * - * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). + * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ "reactions/delete-for-issue": { parameters: { @@ -99290,49 +100612,6 @@ export interface operations { }; }; }; - /** - * Enable Git LFS for a repository - * @description Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. - */ - "repos/enable-lfs-for-repo": { - parameters: { - path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; - responses: { - 202: components["responses"]["accepted"]; - /** - * @description We will return a 403 with one of the following messages: - * - * - Git LFS support not enabled because Git LFS is globally disabled. - * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. - * - Git LFS support not enabled because Git LFS is disabled for . - */ - 403: { - content: never; - }; - }; - }; - /** - * Disable Git LFS for a repository - * @description Disables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. - */ - "repos/disable-lfs-for-repo": { - parameters: { - path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - }; - }; /** * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. @@ -100012,6 +101291,38 @@ export interface operations { }; }; }; + /** + * Enable private vulnerability reporting for a repository + * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." + */ + "repos/enable-private-vulnerability-reporting": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 422: components["responses"]["bad_request"]; + }; + }; + /** + * Disable private vulnerability reporting for a repository + * @description Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". + */ + "repos/disable-private-vulnerability-reporting": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 422: components["responses"]["bad_request"]; + }; + }; /** * List repository projects * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. @@ -100284,12 +101595,12 @@ export interface operations { }; /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + * @description List the reactions to a [pull request review comment](https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request). */ "reactions/list-for-pull-request-review-comment": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -100315,7 +101626,7 @@ export interface operations { }; /** * Create reaction for a pull request review comment - * @description Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. + * @description Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ "reactions/create-for-pull-request-review-comment": { parameters: { @@ -100329,7 +101640,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the pull request review comment. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment. * @enum {string} */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; @@ -100356,7 +101667,7 @@ export interface operations { * Delete a pull request comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * - * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ "reactions/delete-for-pull-request-comment": { parameters: { @@ -100380,7 +101691,7 @@ export interface operations { * * Lists details of a pull request by providing its number. * - * When you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. * @@ -100667,7 +101978,7 @@ export interface operations { }; /** * List commits on a pull request - * @description Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. + * @description Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) endpoint. */ "pulls/list-commits": { parameters: { @@ -100932,7 +102243,7 @@ export interface operations { * Create a review for a pull request * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * - * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request)." + * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * * **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. * @@ -100954,7 +102265,7 @@ export interface operations { /** @description **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. */ body?: string; /** - * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request) when you are ready. + * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready. * @enum {string} */ event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; @@ -101099,7 +102410,7 @@ export interface operations { }; /** * Dismiss a review for a pull request - * @description **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. + * @description **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ "pulls/dismiss-review": { parameters: { @@ -101136,7 +102447,7 @@ export interface operations { }; /** * Submit a review for a pull request - * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls#create-a-review-for-a-pull-request)." + * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." */ "pulls/submit-review": { parameters: { @@ -101187,7 +102498,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/reference/repos#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ + /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ expected_head_sha?: string; } | null; }; @@ -101210,7 +102521,7 @@ export interface operations { * Get a repository README * @description Gets the preferred README for a repository. * - * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. */ "repos/get-readme": { parameters: { @@ -101238,7 +102549,7 @@ export interface operations { * Get a repository README for a directory * @description Gets the README from a repository directory. * - * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. */ "repos/get-readme-in-directory": { parameters: { @@ -101438,7 +102749,7 @@ export interface operations { }; /** * Generate release notes content for a release - * @description Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. + * @description Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ "repos/generate-release-notes": { parameters: { @@ -101655,7 +102966,7 @@ export interface operations { * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. * * **Notes:** - * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List assets for a release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)" + * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)" * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. @@ -101692,12 +103003,12 @@ export interface operations { }; /** * List reactions for a release - * @description List the reactions to a [release](https://docs.github.com/rest/reference/repos#releases). + * @description List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ "reactions/list-for-release": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a release. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -101723,7 +103034,7 @@ export interface operations { }; /** * Create reaction for a release - * @description Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. + * @description Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ "reactions/create-for-release": { parameters: { @@ -101737,7 +103048,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the release. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release. * @enum {string} */ content: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; @@ -101764,7 +103075,7 @@ export interface operations { * Delete a release reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * - * Delete a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). + * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ "reactions/delete-for-release": { parameters: { @@ -102292,6 +103603,32 @@ export interface operations { }; }; }; + /** + * Request a CVE for a repository security advisory + * @description If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." + * + * You may request a CVE for public repositories, but cannot do so for private repositories. + * + * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + * + * In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + */ + "security-advisories/create-repository-advisory-cve-request": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + ghsa_id: components["parameters"]["ghsa_id"]; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** * List stargazers * @description Lists the people that have starred the repository. @@ -103408,7 +104745,7 @@ export interface operations { * Search code * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: * @@ -103430,11 +104767,11 @@ export interface operations { "search/code": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. */ q: string; /** * @deprecated - * @description **This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) + * @description **This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "indexed"; /** @@ -103468,7 +104805,7 @@ export interface operations { * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match - * metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: * @@ -103477,9 +104814,9 @@ export interface operations { "search/commits": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ + /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "author-date" | "committer-date"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -103505,7 +104842,7 @@ export interface operations { * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. * @@ -103518,9 +104855,9 @@ export interface operations { "search/issues-and-pull-requests": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ + /** @description Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -103548,7 +104885,7 @@ export interface operations { * Search labels * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: * @@ -103561,9 +104898,9 @@ export interface operations { query: { /** @description The id of the repository. */ repository_id: number; - /** @description The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */ + /** @description The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). */ q: string; - /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ + /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "created" | "updated"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -103591,7 +104928,7 @@ export interface operations { * Search repositories * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: * @@ -103602,9 +104939,9 @@ export interface operations { "search/repos": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ + /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -103631,7 +104968,7 @@ export interface operations { * Search topics * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: * @@ -103642,7 +104979,7 @@ export interface operations { "search/topics": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). */ q: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -103666,7 +105003,7 @@ export interface operations { * Search users * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you're looking for a list of popular users, you might try this query: * @@ -103679,9 +105016,9 @@ export interface operations { "search/users": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ + /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "followers" | "repositories" | "joined"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -104110,12 +105447,12 @@ export interface operations { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ "reactions/list-for-team-discussion-comment-legacy": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -104143,7 +105480,7 @@ export interface operations { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. */ "reactions/create-for-team-discussion-comment-legacy": { parameters: { @@ -104157,7 +105494,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. * @enum {string} */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; @@ -104178,12 +105515,12 @@ export interface operations { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ "reactions/list-for-team-discussion-legacy": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */ + /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -104210,7 +105547,7 @@ export interface operations { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. */ "reactions/create-for-team-discussion-legacy": { parameters: { @@ -104223,7 +105560,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. + * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. * @enum {string} */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; @@ -104664,7 +106001,7 @@ export interface operations { * @deprecated * @description **Note**: Repositories inherited through a parent team will also be checked. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-repository) endpoint. + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ @@ -104696,7 +106033,7 @@ export interface operations { /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. + * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -104733,7 +106070,7 @@ export interface operations { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. + * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -105162,7 +106499,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user) endpoint. */ + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -107588,7 +108925,7 @@ export interface operations { * * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". */ "users/get-by-username": { parameters: { @@ -108456,7 +109793,7 @@ export interface operations { /** @description Response */ 200: { content: { - "text/plain": string; + "application/json": string; }; }; }; diff --git a/packages/openapi-typescript/examples/github-api.yaml b/packages/openapi-typescript/examples/github-api.yaml index c71efb40b..6c8882f25 100644 --- a/packages/openapi-typescript/examples/github-api.yaml +++ b/packages/openapi-typescript/examples/github-api.yaml @@ -27,10 +27,6 @@ tags: description: Retrieve code scanning alerts from a repository. - name: codes-of-conduct description: Insight into codes of conduct for your communities. -- name: codespaces - description: Endpoints to manage Codespaces using the REST API. -- name: copilot - description: Endpoints to manage Copilot using the REST API. - name: emojis description: List emojis available to use on GitHub. - name: dependabot @@ -43,8 +39,6 @@ tags: description: Raw Git functionality. - name: gitignore description: View gitignore templates -- name: interactions - description: Owner or admin management of users interactions. - name: issues description: Interact with GitHub Issues. - name: licenses @@ -77,12 +71,18 @@ tags: description: Look for stuff on GitHub. - name: secret-scanning description: Retrieve secret scanning alerts from a repository. -- name: security-advisories - description: Manage security advisories. - name: teams description: Interact with GitHub Teams. - name: users description: Interact with and view information about users and also current user. +- name: codespaces + description: Endpoints to manage Codespaces using the REST API. +- name: copilot + description: Endpoints to manage Copilot using the REST API. +- name: security-advisories + description: Manage security advisories. +- name: interactions + description: Owner or admin management of users interactions. servers: - url: https://api.github.com externalDocs: @@ -117,8 +117,10 @@ paths: "/advisories": get: summary: List global security advisories - description: List global security advisories and filter using parameters such - as ecosystem, GHSA ID, CVE ID, etc. + description: |- + Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. + + 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)." tags: - security-advisories operationId: security-advisories/list-global-advisories @@ -181,8 +183,10 @@ paths: - critical - name: cwes in: query - description: If specified, only advisories with these Common Weakness Enumerations - (CWEs) will be returned. + description: |- + If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. + + Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` schema: oneOf: - type: string @@ -196,10 +200,11 @@ paths: type: boolean - name: affects in: query - description: If specified, return advisories that affect any of `package` - or `package@version`. A maximum of 1000 packages can be specified. If the - query parameter causes the URL to exceed the maximum URL length supported - by your client, you must specify fewer packages. + description: |- + If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. + If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. + + Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` schema: oneOf: - type: string @@ -685,7 +690,7 @@ paths: delete: summary: Delete an installation for the authenticated app description: |- - Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. + Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. 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. tags: @@ -2354,7 +2359,7 @@ paths: description: |- Revokes the installation token you're using to authenticate as an installation and access this endpoint. - Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app)" endpoint. + Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. 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. tags: @@ -2486,7 +2491,8 @@ paths: "/licenses": get: summary: Get all commonly used licenses - description: '' + 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)." tags: - licenses operationId: licenses/get-all-commonly-used @@ -2523,7 +2529,8 @@ paths: "/licenses/{license}": get: summary: Get a license - description: '' + description: Gets information about a specific license. For more information, + see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." tags: - licenses operationId: licenses/get @@ -7261,7 +7268,6 @@ paths: config: type: object description: Key/value pairs to provide settings for this webhook. - [These are defined below](https://docs.github.com/rest/reference/orgs#create-hook-config-params). properties: url: "$ref": "#/components/schemas/webhook-config-url" @@ -7388,7 +7394,6 @@ paths: config: type: object description: Key/value pairs to provide settings for this webhook. - [These are defined below](https://docs.github.com/rest/reference/orgs#update-hook-config-params). properties: url: "$ref": "#/components/schemas/webhook-config-url" @@ -9006,7 +9011,7 @@ paths: value: message: You cannot specify an organization member to remove as an outside collaborator. - documentation_url: https://docs.github.com/rest/reference/orgs#remove-outside-collaborator + documentation_url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -10630,6 +10635,77 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/orgs/{org}/security-advisories": + get: + summary: List repository security advisories for an organization + description: |- + Lists repository security advisories for an organization. + + To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission. + tags: + - security-advisories + operationId: security-advisories/list-org-repository-advisories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/direction" + - name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - published + default: created + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - name: per_page + description: The number of advisories to return per page. + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: state + description: Filter by the state of the repository advisories. Only advisories + of this state will be returned. + in: query + required: false + schema: + type: string + enum: + - triage + - draft + - published + - closed + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/repository-advisory" + examples: + default: + "$ref": "#/components/examples/list-repository-advisories" + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories "/orgs/{org}/security-managers": get: summary: List security manager teams @@ -11522,7 +11598,7 @@ paths: get: summary: List reactions for a team discussion comment description: |- - List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. tags: @@ -11537,7 +11613,7 @@ paths: - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/comment-number" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. in: query required: false @@ -11577,7 +11653,7 @@ paths: post: summary: Create reaction for a team discussion comment description: |- - Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. tags: @@ -11600,7 +11676,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. enum: - "+1" @@ -11648,7 +11724,7 @@ paths: description: |- **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). tags: - reactions operationId: reactions/delete-for-team-discussion-comment @@ -11673,7 +11749,7 @@ paths: get: summary: List reactions for a team discussion description: |- - List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. tags: @@ -11687,7 +11763,7 @@ paths: - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/discussion-number" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. in: query required: false @@ -11727,7 +11803,7 @@ paths: post: summary: Create reaction for a team discussion description: |- - Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. tags: @@ -11749,7 +11825,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. enum: - "+1" @@ -11796,7 +11872,7 @@ paths: description: |- **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). tags: - reactions operationId: reactions/delete-for-team-discussion @@ -13466,6 +13542,17 @@ paths: description: |- **Note:** Accessing this endpoint does not count against your REST API rate limit. + Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + * The `core` object provides your rate limit status for all non-search-related resources in the REST API. + * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." + * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." + * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." + * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/overview/api-versions)." + **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. tags: - rate-limit @@ -19245,7 +19332,7 @@ paths: to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs - and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." + and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -19560,10 +19647,9 @@ paths: type: array description: Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` - and `description`. A maximum of three actions are accepted. See - the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) - description. To learn more about check runs and requested actions, - see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." + and `description`. A maximum of three actions are accepted. To + learn more about check runs and requested actions, see "[Check + runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object @@ -19743,7 +19829,7 @@ paths: description: |- **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. tags: - checks operationId: checks/create-suite @@ -20668,11 +20754,12 @@ paths: with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use - this endpoint.\n\nThere are two places where you can upload code scanning - results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` - or `--ref refs/pull/42/head`, then the results appear as alerts in a pull - request check. For more information, see \"[Triaging code scanning alerts - in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n + this endpoint. For troubleshooting information, see \"[Troubleshooting SARIF + uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere + are two places where you can upload code scanning results.\n - If you upload + to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, + then the results appear as alerts in a pull request check. For more information, + see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou @@ -20685,8 +20772,10 @@ paths: the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and - remove the most noisy queries.\n\n\n| **SARIF data** | **Maximum - values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| + remove the most noisy queries. For more information, see \"[SARIF results + exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| + **SARIF data** | **Maximum values** | **Additional limits** + \ |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per @@ -21546,7 +21635,7 @@ paths: Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." - The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations). + The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). **Updating an existing collaborator's permission level** @@ -21699,7 +21788,7 @@ paths: get: summary: List commit comments for a repository description: |- - Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). Comments are ordered by ascending ID. tags: @@ -21836,7 +21925,7 @@ paths: "/repos/{owner}/{repo}/comments/{comment_id}/reactions": get: summary: List reactions for a commit comment - description: List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + description: List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). tags: - reactions operationId: reactions/list-for-commit-comment @@ -21848,7 +21937,7 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. in: query required: false @@ -21889,7 +21978,7 @@ paths: subcategory: reactions post: summary: Create reaction for a commit comment - description: Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + description: Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. tags: @@ -21911,7 +22000,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment. enum: - "+1" @@ -21960,7 +22049,7 @@ paths: description: |- **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. - Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). tags: - reactions operationId: reactions/delete-for-commit-comment @@ -22683,12 +22772,12 @@ paths: the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks - support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) + support [a custom media type](https://docs.github.com/rest/overview/media-types) for\nretrieving the raw content or rendered HTML (when supported). All content - types support [a custom media\ntype](https://docs.github.com/rest/reference/repos#custom-media-types) + types support [a custom media\ntype](https://docs.github.com/rest/overview/media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n* \ To get a repository's contents recursively, you can [recursively get the - tree](https://docs.github.com/rest/reference/git#trees).\n* This API has + tree](https://docs.github.com/rest/git/trees#get-a-tree).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/rest/git/trees#get-a-tree).\n * Download URLs expire and are meant to be used just once. To ensure the @@ -22784,7 +22873,7 @@ paths: description: |- Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. - **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. tags: - repos operationId: repos/create-or-update-file-contents @@ -22922,7 +23011,7 @@ paths: You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. - **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. tags: - repos operationId: repos/delete-file @@ -24214,7 +24303,7 @@ paths: **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." - **Note:** To create or update secrets for an environment, see "[Secrets](/rest/reference/actions#secrets)." + **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. tags: @@ -25363,12 +25452,13 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: The name of the fully qualified reference to update. For example, - `refs/heads/master`. If the value doesn't start with `refs` and have at - least two slashes, it will be rejected. + description: The name of the reference to update (for example, `heads/featureA`). + Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). + For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" + in the Git documentation. in: path required: true - example: refs/head/master + example: heads/featureA schema: type: string x-multi-segment: true @@ -25739,7 +25829,7 @@ paths: get: summary: Get a tree description: |- - Returns a single tree using the SHA1 value for that tree. + Returns a single tree using the SHA1 value or ref name for that tree. If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. @@ -25755,6 +25845,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: tree_sha + description: The SHA1 value or ref (branch or tag) name of the tree. in: path required: true schema: @@ -25858,7 +25949,6 @@ paths: config: type: object description: Key/value pairs to provide settings for this webhook. - [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). properties: url: "$ref": "#/components/schemas/webhook-config-url" @@ -25930,7 +26020,7 @@ paths: get: summary: Get a repository webhook description: Returns a webhook configured in a repository. To get only the webhook - `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." + `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." tags: - repos operationId: repos/get-webhook @@ -25963,7 +26053,7 @@ paths: description: Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook - `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." + `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." tags: - repos operationId: repos/update-webhook @@ -25984,7 +26074,6 @@ paths: config: type: object description: Key/value pairs to provide settings for this webhook. - [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). properties: url: "$ref": "#/components/schemas/webhook-config-url" @@ -26079,7 +26168,7 @@ paths: get: summary: Get a webhook configuration for a repository description: |- - Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." + Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. tags: @@ -26110,7 +26199,7 @@ paths: patch: summary: Update a webhook configuration for a repository description: |- - Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." + Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. tags: @@ -27410,7 +27499,7 @@ paths: "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": get: summary: List reactions for an issue comment - description: List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + description: List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). tags: - reactions operationId: reactions/list-for-issue-comment @@ -27422,7 +27511,7 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. in: query required: false @@ -27463,7 +27552,7 @@ paths: subcategory: reactions post: summary: Create reaction for an issue comment - description: Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + description: Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. tags: @@ -27485,7 +27574,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment. enum: - "+1" @@ -27534,7 +27623,7 @@ paths: description: |- **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. - Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). tags: - reactions operationId: reactions/delete-for-issue-comment @@ -28466,7 +28555,7 @@ paths: "/repos/{owner}/{repo}/issues/{issue_number}/reactions": get: summary: List reactions for an issue - description: List the reactions to an [issue](https://docs.github.com/rest/reference/issues). + description: List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). tags: - reactions operationId: reactions/list-for-issue @@ -28478,7 +28567,7 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. in: query required: false @@ -28521,7 +28610,7 @@ paths: subcategory: reactions post: summary: Create reaction for an issue - description: Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). + description: Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. tags: @@ -28543,7 +28632,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue. enum: - "+1" @@ -28592,7 +28681,7 @@ paths: description: |- **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. - Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). + Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). tags: - reactions operationId: reactions/delete-for-issue @@ -29058,56 +29147,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repos/{owner}/{repo}/lfs": - put: - summary: Enable Git LFS for a repository - description: Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` - scope. - operationId: repos/enable-lfs-for-repo - tags: - - repos - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/lfs#enable-git-lfs-for-a-repository - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - responses: - '202': - "$ref": "#/components/responses/accepted" - '403': - description: |- - We will return a 403 with one of the following messages: - - - Git LFS support not enabled because Git LFS is globally disabled. - - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. - - Git LFS support not enabled because Git LFS is disabled for . - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: repos - subcategory: lfs - delete: - summary: Disable Git LFS for a repository - description: Disables Git LFS for a repository. Access tokens must have the - `admin:enterprise` scope. - operationId: repos/disable-lfs-for-repo - tags: - - repos - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/lfs#disable-git-lfs-for-a-repository - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: repos - subcategory: lfs "/repos/{owner}/{repo}/license": get: summary: Get the license for a repository @@ -30145,6 +30184,55 @@ paths: enabledForGitHubApps: true category: pages subcategory: pages + "/repos/{owner}/{repo}/private-vulnerability-reporting": + put: + summary: Enable private vulnerability reporting for a repository + description: Enables private vulnerability reporting for a repository. The authenticated + user must have admin access to the repository. For more information, see "[Privately + reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." + tags: + - repos + operationId: repos/enable-private-vulnerability-reporting + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + "$ref": "#/components/responses/no_content" + '422': + "$ref": "#/components/responses/bad_request" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + delete: + summary: Disable private vulnerability reporting for a repository + description: Disables private vulnerability reporting for a repository. The + authenticated user must have admin access to the repository. For more information, + see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". + tags: + - repos + operationId: repos/disable-private-vulnerability-reporting + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + "$ref": "#/components/responses/no_content" + '422': + "$ref": "#/components/responses/bad_request" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos "/repos/{owner}/{repo}/projects": get: summary: List repository projects @@ -30614,7 +30702,7 @@ paths: "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": get: summary: List reactions for a pull request review comment - description: List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + description: List the reactions to a [pull request review comment](https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request). tags: - reactions operationId: reactions/list-for-pull-request-review-comment @@ -30626,7 +30714,7 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. in: query required: false @@ -30667,7 +30755,7 @@ paths: subcategory: reactions post: summary: Create reaction for a pull request review comment - description: Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). + description: Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. tags: @@ -30689,7 +30777,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment. enum: - "+1" @@ -30738,7 +30826,7 @@ paths: description: |- **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` - Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). tags: - reactions operationId: reactions/delete-for-pull-request-comment @@ -30766,7 +30854,7 @@ paths: Lists details of a pull request by providing its number. - When you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. @@ -31238,7 +31326,7 @@ paths: summary: List commits on a pull request description: Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the - [List commits](https://docs.github.com/rest/reference/repos#list-commits) + [List commits](https://docs.github.com/rest/commits/commits#list-commits) endpoint. tags: - pulls @@ -31640,7 +31728,7 @@ paths: description: |- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. - Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request)." + Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. @@ -31678,7 +31766,7 @@ paths: description: 'The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, - which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request) + which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.' enum: - APPROVE @@ -31906,7 +31994,7 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": put: summary: Dismiss a review for a pull request - description: "**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), + description: "**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews." tags: @@ -31966,7 +32054,7 @@ paths: summary: Submit a review for a pull request description: Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review - for a pull request](https://docs.github.com/rest/pulls#create-a-review-for-a-pull-request)." + for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." tags: - pulls operationId: pulls/submit-review @@ -32057,7 +32145,7 @@ paths: This is the most recent commit on the pull request''s branch. If the expected SHA does not match the pull request''s HEAD, you will receive a `422 Unprocessable Entity` status. You can use - the "[List commits](https://docs.github.com/rest/reference/repos#list-commits)" + the "[List commits](https://docs.github.com/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request''s current HEAD ref.' examples: @@ -32096,7 +32184,7 @@ paths: description: |- Gets the preferred README for a repository. - READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. tags: - repos operationId: repos/get-readme @@ -32138,7 +32226,7 @@ paths: description: |- Gets the README from a repository directory. - READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. tags: - repos operationId: repos/get-readme-in-directory @@ -32445,7 +32533,7 @@ paths: "/repos/{owner}/{repo}/releases/generate-notes": post: summary: Generate release notes content for a release - description: Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). + description: Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when @@ -32783,7 +32871,7 @@ paths: receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub renames asset filenames that have special characters, non-alphanumeric characters, - and leading or trailing periods. The \"[List assets for a release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)\"\nendpoint + and leading or trailing periods. The \"[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` @@ -32846,7 +32934,7 @@ paths: "/repos/{owner}/{repo}/releases/{release_id}/reactions": get: summary: List reactions for a release - description: List the reactions to a [release](https://docs.github.com/rest/reference/repos#releases). + description: List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release). tags: - reactions operationId: reactions/list-for-release @@ -32858,7 +32946,7 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/release-id" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. in: query required: false @@ -32897,7 +32985,7 @@ paths: subcategory: reactions post: summary: Create reaction for a release - description: 'Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). + description: 'Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.' tags: @@ -32919,7 +33007,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release. enum: - "+1" @@ -32966,7 +33054,7 @@ paths: description: |- **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. - Delete a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). + Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). tags: - reactions operationId: reactions/delete-for-release @@ -33884,6 +33972,43 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: repository-advisories + "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": + post: + summary: Request a CVE for a repository security advisory + description: |- + If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." + + You may request a CVE for public repositories, but cannot do so for private repositories. + + You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + + In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + tags: + - security-advisories + operationId: security-advisories/create-repository-advisory-cve-request + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/ghsa_id" + responses: + '202': + "$ref": "#/components/responses/accepted" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories "/repos/{owner}/{repo}/stargazers": get: summary: List stargazers @@ -35512,7 +35637,7 @@ paths: description: |- Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). - When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: @@ -35541,7 +35666,7 @@ paths: description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). + learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. in: query @@ -35552,7 +35677,7 @@ paths: deprecated: true description: "**This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed - by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)" + by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)" in: query required: false schema: @@ -35617,7 +35742,7 @@ paths: Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match - metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + metadata](https://docs.github.com/rest/search/search#text-match-metadata). For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: @@ -35633,7 +35758,7 @@ paths: description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). + learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. in: query @@ -35642,7 +35767,7 @@ paths: type: string - name: sort description: 'Sorts the results of your query by `author-date` or `committer-date`. - Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)' + Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -35690,7 +35815,7 @@ paths: Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. @@ -35710,7 +35835,7 @@ paths: description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). + learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. in: query @@ -35722,7 +35847,7 @@ paths: `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: - [best match](https://docs.github.com/rest/reference/search#ranking-search-results)' + [best match](https://docs.github.com/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -35784,7 +35909,7 @@ paths: description: |- Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). - When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: @@ -35807,14 +35932,14 @@ paths: - name: q description: The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing - a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). + a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). in: query required: true schema: type: string - name: sort description: 'Sorts the results of your query by when the label was `created` - or `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)' + or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -35867,7 +35992,7 @@ paths: description: |- Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). - When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: @@ -35885,7 +36010,7 @@ paths: description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). + learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. in: query @@ -35895,7 +36020,7 @@ paths: - name: sort description: 'Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: - [best match](https://docs.github.com/rest/reference/search#ranking-search-results)' + [best match](https://docs.github.com/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -35948,7 +36073,7 @@ paths: description: |- Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. - When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: @@ -35966,7 +36091,7 @@ paths: description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). + learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). in: query required: true schema: @@ -36009,7 +36134,7 @@ paths: description: |- Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). - When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For example, if you're looking for a list of popular users, you might try this query: @@ -36029,7 +36154,7 @@ paths: description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). + learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. in: query @@ -36038,7 +36163,7 @@ paths: type: string - name: sort description: 'Sorts the results of your query by number of `followers` or - `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)' + `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)' in: query required: false schema: @@ -36682,7 +36807,7 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). tags: - reactions operationId: reactions/list-for-team-discussion-comment-legacy @@ -36694,7 +36819,7 @@ paths: - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/comment-number" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. in: query required: false @@ -36739,7 +36864,7 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. tags: - reactions operationId: reactions/create-for-team-discussion-comment-legacy @@ -36759,7 +36884,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. enum: - "+1" @@ -36800,7 +36925,7 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). tags: - reactions operationId: reactions/list-for-team-discussion-legacy @@ -36811,7 +36936,7 @@ paths: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/discussion-number" - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. in: query required: false @@ -36856,7 +36981,7 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. tags: - reactions operationId: reactions/create-for-team-discussion-legacy @@ -36875,7 +37000,7 @@ paths: properties: content: type: string - description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. enum: - "+1" @@ -37478,7 +37603,7 @@ paths: description: |- **Note**: Repositories inherited through a parent team will also be checked. - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-repository) endpoint. + **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: tags: @@ -37516,7 +37641,7 @@ paths: put: summary: Add or update team repository permissions (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. + **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. @@ -37571,7 +37696,7 @@ paths: delete: summary: Remove a repository from a team (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. + **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. tags: @@ -38240,7 +38365,7 @@ paths: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for - the authenticated user](https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user) + the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: @@ -42078,7 +42203,7 @@ paths: The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). - The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". + The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". tags: - users operationId: users/get-by-username @@ -43346,7 +43471,7 @@ paths: '200': description: Response content: - text/plain: + application/json: schema: type: string examples: @@ -43364,7 +43489,7 @@ x-webhooks: summary: |- This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/rest/branches/branch-protection)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A branch protection rule was created. operationId: branch-protection-rule/created externalDocs: @@ -45411,18 +45536,18 @@ x-webhooks: subcategory: deployment-protection-rule supported-webhook-types: - app - deployment-status-created: + deployment-review-approved: post: summary: |- - This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. - For activity relating to deployment creation, use the `deployment` event. + For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A new deployment status was created. - operationId: deployment-status/created + description: A deployment review was approved. + operationId: deployment-review/approved externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-status + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-review parameters: - name: User-Agent in: header @@ -45464,7 +45589,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deployment-status-created" + "$ref": "#/components/schemas/webhook-deployment-review-approved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45472,25 +45597,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deployment-status + subcategory: deployment-review supported-webhook-types: - - repository - - organization - app - discussion-answered: + deployment-review-rejected: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A comment on the discussion was marked as the answer. - operationId: discussion/answered + To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + description: A deployment review was rejected. + operationId: deployment-review/rejected externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-review parameters: - name: User-Agent in: header @@ -45532,7 +45653,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-answered" + "$ref": "#/components/schemas/webhook-deployment-review-rejected" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45540,25 +45661,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion + subcategory: deployment-review supported-webhook-types: - - repository - - organization - app - discussion-category-changed: + deployment-review-requested: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. + This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: The category of a discussion was changed. - operationId: discussion/category-changed + To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + description: A deployment review was requested. + operationId: deployment-review/requested externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-review parameters: - name: User-Agent in: header @@ -45600,7 +45717,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-category-changed" + "$ref": "#/components/schemas/webhook-deployment-review-requested" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45608,25 +45725,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion + subcategory: deployment-review supported-webhook-types: - - repository - - organization - app - discussion-closed: + deployment-status-created: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. + This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + For activity relating to deployment creation, use the `deployment` event. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was closed. - operationId: discussion/closed + To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + description: A new deployment status was created. + operationId: deployment-status/created externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-status parameters: - name: User-Agent in: header @@ -45640,7 +45753,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: discussions + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -45668,7 +45781,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-closed" + "$ref": "#/components/schemas/webhook-deployment-status-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45676,25 +45789,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion + subcategory: deployment-status supported-webhook-types: - repository - organization - app - discussion-comment-created: + discussion-answered: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A comment on a discussion was created. - operationId: discussion-comment/created + description: A comment on the discussion was marked as the answer. + operationId: discussion/answered externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -45736,7 +45849,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-comment-created" + "$ref": "#/components/schemas/webhook-discussion-answered" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45744,25 +45857,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion-comment + subcategory: discussion supported-webhook-types: - repository - organization - app - discussion-comment-deleted: + discussion-category-changed: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A comment on a discussion was deleted. - operationId: discussion-comment/deleted + description: The category of a discussion was changed. + operationId: discussion/category-changed externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -45804,7 +45917,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-comment-deleted" + "$ref": "#/components/schemas/webhook-discussion-category-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45812,25 +45925,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion-comment + subcategory: discussion supported-webhook-types: - repository - organization - app - discussion-comment-edited: + discussion-closed: post: summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A comment on a discussion was edited. - operationId: discussion-comment/edited + description: A discussion was closed. + operationId: discussion/closed externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -45844,7 +45957,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: discussions schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -45872,7 +45985,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-comment-edited" + "$ref": "#/components/schemas/webhook-discussion-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45880,25 +45993,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion-comment + subcategory: discussion supported-webhook-types: - repository - organization - app - discussion-created: + discussion-comment-created: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - For activity relating to a comment on a discussion, use the `discussion_comment` event. + For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was created. - operationId: discussion/created + description: A comment on a discussion was created. + operationId: discussion-comment/created externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment parameters: - name: User-Agent in: header @@ -45940,7 +46053,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-created" + "$ref": "#/components/schemas/webhook-discussion-comment-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45948,25 +46061,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion + subcategory: discussion-comment supported-webhook-types: - repository - organization - app - discussion-deleted: + discussion-comment-deleted: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - For activity relating to a comment on a discussion, use the `discussion_comment` event. + For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was deleted. - operationId: discussion/deleted + description: A comment on a discussion was deleted. + operationId: discussion-comment/deleted externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment parameters: - name: User-Agent in: header @@ -46008,7 +46121,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-deleted" + "$ref": "#/components/schemas/webhook-discussion-comment-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46016,26 +46129,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion + subcategory: discussion-comment supported-webhook-types: - repository - organization - app - discussion-edited: + discussion-comment-edited: post: summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). + This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - For activity relating to a comment on a discussion, use the `discussion_comment` event. + For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: The title or body on a discussion was edited, or the category of - the discussion was changed. - operationId: discussion/edited + description: A comment on a discussion was edited. + operationId: discussion-comment/edited externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment parameters: - name: User-Agent in: header @@ -46077,7 +46189,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-edited" + "$ref": "#/components/schemas/webhook-discussion-comment-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46085,12 +46197,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: discussion + subcategory: discussion-comment supported-webhook-types: - repository - organization - app - discussion-labeled: + discussion-created: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46100,8 +46212,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A label was added to a discussion. - operationId: discussion/labeled + description: A discussion was created. + operationId: discussion/created externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46145,7 +46257,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-labeled" + "$ref": "#/components/schemas/webhook-discussion-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46158,7 +46270,7 @@ x-webhooks: - repository - organization - app - discussion-locked: + discussion-deleted: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46168,8 +46280,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was locked. - operationId: discussion/locked + description: A discussion was deleted. + operationId: discussion/deleted externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46213,7 +46325,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-locked" + "$ref": "#/components/schemas/webhook-discussion-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46226,7 +46338,7 @@ x-webhooks: - repository - organization - app - discussion-pinned: + discussion-edited: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46236,8 +46348,9 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was pinned. - operationId: discussion/pinned + description: The title or body on a discussion was edited, or the category of + the discussion was changed. + operationId: discussion/edited externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46281,7 +46394,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-pinned" + "$ref": "#/components/schemas/webhook-discussion-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46294,7 +46407,7 @@ x-webhooks: - repository - organization - app - discussion-reopened: + discussion-labeled: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46304,8 +46417,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was reopened. - operationId: discussion/reopened + description: A label was added to a discussion. + operationId: discussion/labeled externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46321,7 +46434,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: discussions + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -46349,7 +46462,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-reopened" + "$ref": "#/components/schemas/webhook-discussion-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46362,7 +46475,7 @@ x-webhooks: - repository - organization - app - discussion-transferred: + discussion-locked: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46372,8 +46485,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was transferred to another repository. - operationId: discussion/transferred + description: A discussion was locked. + operationId: discussion/locked externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46417,7 +46530,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-transferred" + "$ref": "#/components/schemas/webhook-discussion-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46430,7 +46543,7 @@ x-webhooks: - repository - organization - app - discussion-unanswered: + discussion-pinned: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46440,8 +46553,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A comment on the discussion was unmarked as the answer. - operationId: discussion/unanswered + description: A discussion was pinned. + operationId: discussion/pinned externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46485,7 +46598,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-unanswered" + "$ref": "#/components/schemas/webhook-discussion-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46498,7 +46611,7 @@ x-webhooks: - repository - organization - app - discussion-unlabeled: + discussion-reopened: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46508,8 +46621,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A label was removed from a discussion. - operationId: discussion/unlabeled + description: A discussion was reopened. + operationId: discussion/reopened externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46525,7 +46638,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: discussions schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -46553,7 +46666,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-unlabeled" + "$ref": "#/components/schemas/webhook-discussion-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46566,7 +46679,7 @@ x-webhooks: - repository - organization - app - discussion-unlocked: + discussion-transferred: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46576,8 +46689,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was unlocked. - operationId: discussion/unlocked + description: A discussion was transferred to another repository. + operationId: discussion/transferred externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46621,7 +46734,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-unlocked" + "$ref": "#/components/schemas/webhook-discussion-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46634,7 +46747,7 @@ x-webhooks: - repository - organization - app - discussion-unpinned: + discussion-unanswered: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). @@ -46644,8 +46757,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. - description: A discussion was unpinned. - operationId: discussion/unpinned + description: A comment on the discussion was unmarked as the answer. + operationId: discussion/unanswered externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: @@ -46689,7 +46802,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-discussion-unpinned" + "$ref": "#/components/schemas/webhook-discussion-unanswered" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46702,15 +46815,20 @@ x-webhooks: - repository - organization - app - fork: + discussion-unlabeled: post: summary: |- - This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/rest/repos/forks)" in the REST API documentation. + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: fork + For activity relating to a comment on a discussion, use the `discussion_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + + **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + description: A label was removed from a discussion. + operationId: discussion/unlabeled externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#fork + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header @@ -46752,7 +46870,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-fork" + "$ref": "#/components/schemas/webhook-discussion-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -46760,85 +46878,284 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: fork + subcategory: discussion supported-webhook-types: - - business - repository - organization - app - github-app-authorization-revoked: + discussion-unlocked: post: summary: |- - This event occurs when a user revokes their authorization of a GitHub App. For more information, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - A GitHub App receives this webhook by default and cannot unsubscribe from this event. + For activity relating to a comment on a discussion, use the `discussion_comment` event. - Anyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - description: Someone revoked their authorization of a GitHub App. - operationId: github-app-authorization/revoked - externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#github-app-authorization - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: github-app-authorization - supported-webhook-types: - - app - gollum: - post: - summary: |- - This event occurs when someone creates or updates a wiki page. For more information, see "[About wikis](https://docs.github.com/communities/documenting-your-project-with-wikis/about-wikis)." + To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: gollum + **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + description: A discussion was unlocked. + operationId: discussion/unlocked externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#gollum + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-discussion-unlocked" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: discussion + supported-webhook-types: + - repository + - organization + - app + discussion-unpinned: + post: + summary: |- + This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). + + For activity relating to a comment on a discussion, use the `discussion_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. + + **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + description: A discussion was unpinned. + operationId: discussion/unpinned + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-discussion-unpinned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: discussion + supported-webhook-types: + - repository + - organization + - app + fork: + post: + summary: |- + This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/rest/repos/forks)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + operationId: fork + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#fork + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-fork" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: fork + supported-webhook-types: + - business + - repository + - organization + - app + github-app-authorization-revoked: + post: + summary: |- + This event occurs when a user revokes their authorization of a GitHub App. For more information, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. + + A GitHub App receives this webhook by default and cannot unsubscribe from this event. + + Anyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." + description: Someone revoked their authorization of a GitHub App. + operationId: github-app-authorization/revoked + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#github-app-authorization + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: github-app-authorization + supported-webhook-types: + - app + gollum: + post: + summary: |- + This event occurs when someone creates or updates a wiki page. For more information, see "[About wikis](https://docs.github.com/communities/documenting-your-project-with-wikis/about-wikis)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + operationId: gollum + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#gollum parameters: - name: User-Agent in: header @@ -46898,7 +47215,7 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. description: Someone installed a GitHub App on a user or organization account. operationId: installation/created externalDocs: @@ -46960,7 +47277,7 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. description: Someone uninstalled a GitHub App from their user or organization account. operationId: installation/deleted @@ -47023,7 +47340,7 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. description: Someone granted new permissions to a GitHub App. operationId: installation/new-permissions-accepted externalDocs: @@ -47085,7 +47402,7 @@ x-webhooks: summary: |- This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. description: A GitHub App installation was granted access to one or more repositories. operationId: installation-repositories/added externalDocs: @@ -47147,7 +47464,7 @@ x-webhooks: summary: |- This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. description: Access to one or more repositories was revoked for a GitHub App installation. operationId: installation-repositories/removed @@ -47210,7 +47527,7 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. description: Someone blocked access by a GitHub App to their user or organization account. operationId: installation/suspend @@ -47274,7 +47591,7 @@ x-webhooks: account that a GitHub App is installed on. For more information, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API - documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" + documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. description: Somebody renamed the user or organization account that a GitHub App is installed on. @@ -47338,7 +47655,7 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/reference/apps)" in the REST API documentation. + For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. description: A GitHub App that was blocked from accessing a user or organization account was given access the account again. operationId: installation/unsuspend @@ -49444,7 +49761,7 @@ x-webhooks: membership-removed: post: summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the API to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: An organization member was removed from a team. @@ -53753,7 +54070,7 @@ x-webhooks: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A previously closed pull request was reopened. @@ -54347,7 +54664,7 @@ x-webhooks: pull-request-review-thread-resolved: post: summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request review comment threads, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. @@ -54747,7 +55064,7 @@ x-webhooks: push: post: summary: |- - This event occurs when a commit or tag is pushed. + This event occurs when a commit or tag is pushed, or when a repository is cloned. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. @@ -54882,7 +55199,7 @@ x-webhooks: To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. - **Note**: GitHub recommends that you use the newer `package` event instead + **Note**: GitHub recommends that you use the newer `package` event instead. description: A package that was previously published to a registry was updated. operationId: registry-package/updated externalDocs: @@ -55009,7 +55326,7 @@ x-webhooks: release-deleted: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release, pre-release, or draft release was deleted. @@ -55073,7 +55390,7 @@ x-webhooks: release-edited: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: The details of a release, pre-release, or draft release were edited. @@ -55138,7 +55455,7 @@ x-webhooks: release-prereleased: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release was created and identified as a pre-release. A pre-release @@ -55203,7 +55520,7 @@ x-webhooks: release-published: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release, pre-release, or draft of a release was published. @@ -55267,7 +55584,7 @@ x-webhooks: release-released: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release was published, or a pre-release was changed to a release. @@ -55331,7 +55648,7 @@ x-webhooks: release-unpublished: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release or pre-release was unpublished. @@ -56101,20 +56418,18 @@ x-webhooks: - repository - organization - app - repository-transferred: + repository-ruleset-created: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - 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. - operationId: repository/transferred + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + description: A repository ruleset was created. + operationId: repository-ruleset/created externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-ruleset parameters: - name: User-Agent in: header @@ -56156,7 +56471,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56164,22 +56479,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository-ruleset supported-webhook-types: - - business - repository - organization - app - repository-unarchived: + repository-ruleset-deleted: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A previously archived repository was unarchived. - operationId: repository/unarchived + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + description: A repository ruleset was deleted. + operationId: repository-ruleset/deleted externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-ruleset parameters: - name: User-Agent in: header @@ -56221,7 +56537,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56229,22 +56545,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository-ruleset supported-webhook-types: - - business - repository - organization - app - repository-vulnerability-alert-create: + repository-ruleset-edited: post: summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - **Note**: This event is deprecated. Use the `dependabot_alert` event instead. - description: A repository vulnerability alert was created. - operationId: repository-vulnerability-alert/create + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + description: A repository ruleset was edited. + operationId: repository-ruleset/edited externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-ruleset parameters: - name: User-Agent in: header @@ -56286,7 +56603,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56294,20 +56611,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository-vulnerability-alert + subcategory: repository-ruleset supported-webhook-types: - repository - organization - repository-vulnerability-alert-dismiss: + - app + repository-transferred: post: summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - **Note**: This event is deprecated. Use the `dependabot_alert` event instead. - description: A repository vulnerability alert was dismissed. - operationId: repository-vulnerability-alert/dismiss + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + 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. + operationId: repository/transferred externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -56349,7 +56671,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56357,19 +56679,85 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository-vulnerability-alert + subcategory: repository supported-webhook-types: + - business - repository - organization - repository-vulnerability-alert-reopen: + - app + repository-unarchived: + post: + summary: |- + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A previously archived repository was unarchived. + operationId: repository/unarchived + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-repository-unarchived" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: repository + supported-webhook-types: + - business + - repository + - organization + - app + repository-vulnerability-alert-create: post: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. **Note**: This event is deprecated. Use the `dependabot_alert` event instead. - description: A previously dismissed or resolved repository vulnerability alert - was reopened. - operationId: repository-vulnerability-alert/reopen + description: A repository vulnerability alert was created. + operationId: repository-vulnerability-alert/create externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert parameters: @@ -56413,7 +56801,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56425,14 +56813,14 @@ x-webhooks: supported-webhook-types: - repository - organization - repository-vulnerability-alert-resolve: + repository-vulnerability-alert-dismiss: post: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. **Note**: This event is deprecated. Use the `dependabot_alert` event instead. - description: A repository vulnerability alert was marked as resolved. - operationId: repository-vulnerability-alert/resolve + description: A repository vulnerability alert was dismissed. + operationId: repository-vulnerability-alert/dismiss externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert parameters: @@ -56476,7 +56864,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56488,18 +56876,17 @@ x-webhooks: supported-webhook-types: - repository - organization - secret-scanning-alert-created: + repository-vulnerability-alert-reopen: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + This event occurs when there is activity relating to a security vulnerability alert in a repository. - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was created. - operationId: secret-scanning-alert/created + **Note**: This event is deprecated. Use the `dependabot_alert` event instead. + description: A previously dismissed or resolved repository vulnerability alert + was reopened. + operationId: repository-vulnerability-alert/reopen externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert parameters: - name: User-Agent in: header @@ -56541,7 +56928,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56549,26 +56936,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: secret-scanning-alert + subcategory: repository-vulnerability-alert supported-webhook-types: - repository - organization - - app - secret-scanning-alert-location-created: + repository-vulnerability-alert-resolve: post: summary: |- - This event occurs when there is activity relating to the locations of a secret in a secret scanning alert. - - For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - - For activity relating to secret scanning alerts, use the `secret_scanning_alert` event. + This event occurs when there is activity relating to a security vulnerability alert in a repository. - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - 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. - operationId: secret-scanning-alert-location/created + **Note**: This event is deprecated. Use the `dependabot_alert` event instead. + description: A repository vulnerability alert was marked as resolved. + operationId: repository-vulnerability-alert/resolve externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret_scanning_alert_location + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert parameters: - name: User-Agent in: header @@ -56610,30 +56991,19 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - examples: - default: - "$ref": "#/components/examples/secret-scanning-alert-location-created" - application/x-www-form-urlencoded: - schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" - examples: - default: - "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: secret_scanning_alert_location + subcategory: repository-vulnerability-alert supported-webhook-types: - repository - organization - - app - secret-scanning-alert-reopened: + secret-scanning-alert-created: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -56641,8 +57011,8 @@ x-webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A previously closed secret scanning alert was reopened. - operationId: secret-scanning-alert/reopened + description: A secret scanning alert was created. + operationId: secret-scanning-alert/created externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert parameters: @@ -56686,7 +57056,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56699,18 +57069,21 @@ x-webhooks: - repository - organization - app - secret-scanning-alert-resolved: + secret-scanning-alert-location-created: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to the locations of a secret in a secret scanning alert. - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alerts, use the `secret_scanning_alert` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was closed. - operationId: secret-scanning-alert/resolved + 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. + operationId: secret-scanning-alert-location/created externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret_scanning_alert_location parameters: - name: User-Agent in: header @@ -56752,20 +57125,30 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + examples: + default: + "$ref": "#/components/examples/secret-scanning-alert-location-created" + application/x-www-form-urlencoded: + schema: + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + examples: + default: + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: secret-scanning-alert + subcategory: secret_scanning_alert_location supported-webhook-types: - repository - organization - app - secret-scanning-alert-revoked: + secret-scanning-alert-reopened: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -56773,8 +57156,8 @@ x-webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was marked as revoked. - operationId: secret-scanning-alert/revoked + description: A previously closed secret scanning alert was reopened. + operationId: secret-scanning-alert/reopened externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert parameters: @@ -56818,7 +57201,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-revoked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56831,16 +57214,18 @@ x-webhooks: - repository - organization - app - security-advisory-published: + secret-scanning-alert-resolved: post: summary: |- - This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A security advisory was published to the GitHub community. - operationId: security-advisory/published + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was closed. + operationId: secret-scanning-alert/resolved externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert parameters: - name: User-Agent in: header @@ -56882,7 +57267,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56890,20 +57275,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security-advisory + subcategory: secret-scanning-alert supported-webhook-types: + - repository + - organization - app - security-advisory-updated: + secret-scanning-alert-revoked: post: summary: |- - This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: The metadata or description of a security advisory was changed, - or the security advisory was withdrawn. - operationId: security-advisory/updated + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was marked as revoked. + operationId: secret-scanning-alert/revoked externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert parameters: - name: User-Agent in: header @@ -56945,7 +57333,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-revoked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56953,17 +57341,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security-advisory + subcategory: secret-scanning-alert supported-webhook-types: + - repository + - organization - app - security-advisory-withdrawn: + security-advisory-published: post: summary: |- This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A previously published security advisory was withdrawn. - operationId: security-advisory/withdrawn + description: A security advisory was published to the GitHub community. + operationId: security-advisory/published externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory parameters: @@ -57007,7 +57397,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57018,15 +57408,17 @@ x-webhooks: subcategory: security-advisory supported-webhook-types: - app - security-and-analysis: + security-advisory-updated: post: summary: |- - This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." + This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - operationId: security-and-analysis + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + description: The metadata or description of a security advisory was changed, + or the security advisory was withdrawn. + operationId: security-advisory/updated externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-and-analysis + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory parameters: - name: User-Agent in: header @@ -57068,7 +57460,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57076,87 +57468,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security-and-analysis + subcategory: security-advisory supported-webhook-types: - - repository - - organization - app - sponsorship-cancelled: - post: - summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: |- - A sponsorship was cancelled and the last billing cycle has ended. - - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/cancelled - externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sponsorship - supported-webhook-types: - - sponsors_listing - sponsorship-created: + security-advisory-withdrawn: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor created a sponsorship for a sponsored account. This event - occurs once the payment is successfully processed. - operationId: sponsorship/created + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + description: A previously published security advisory was withdrawn. + operationId: security-advisory/withdrawn externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory parameters: - name: User-Agent in: header @@ -57198,7 +57522,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57206,21 +57530,18 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: security-advisory supported-webhook-types: - - sponsors_listing - sponsorship-edited: + - app + security-and-analysis: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - 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. - operationId: sponsorship/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + operationId: security-and-analysis externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-and-analysis parameters: - name: User-Agent in: header @@ -57262,7 +57583,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-security-and-analysis" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57270,20 +57591,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: security-and-analysis supported-webhook-types: - - sponsors_listing - sponsorship-pending-cancellation: + - repository + - organization + - app + sponsorship-cancelled: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: |- - A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. + A sponsorship was cancelled and the last billing cycle has ended. This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/pending-cancellation + operationId: sponsorship/cancelled externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -57327,7 +57650,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57338,15 +57661,15 @@ x-webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-pending-tier-change: + sponsorship-created: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor scheduled a downgrade to a lower sponsorship tier. The - new tier will become effective on their next billing date. - operationId: sponsorship/pending-tier-change + description: A sponsor created a sponsorship for a sponsored account. This event + occurs once the payment is successfully processed. + operationId: sponsorship/created externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -57390,7 +57713,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57401,17 +57724,16 @@ x-webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-tier-changed: + sponsorship-edited: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - 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. - operationId: sponsorship/tier-changed + 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. + operationId: sponsorship/edited externalDocs: url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -57455,7 +57777,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57466,80 +57788,273 @@ x-webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - star-created: + sponsorship-pending-cancellation: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone starred a repository. - operationId: star/created - externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#star - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-star-created" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: star - supported-webhook-types: - - repository - - organization - - app - star-deleted: - post: - summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: |- + A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone unstarred the repository. - operationId: star/deleted + This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. + operationId: sponsorship/pending-cancellation externalDocs: - url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sponsorship + supported-webhook-types: + - sponsors_listing + sponsorship-pending-tier-change: + post: + summary: |- + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: A sponsor scheduled a downgrade to a lower sponsorship tier. The + new tier will become effective on their next billing date. + operationId: sponsorship/pending-tier-change + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sponsorship + supported-webhook-types: + - sponsors_listing + sponsorship-tier-changed: + post: + summary: |- + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + 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. + operationId: sponsorship/tier-changed + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sponsorship + supported-webhook-types: + - sponsors_listing + star-created: + post: + summary: |- + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone starred a repository. + operationId: star/created + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#star + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-star-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: star + supported-webhook-types: + - repository + - organization + - app + star-deleted: + post: + summary: |- + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone unstarred the repository. + operationId: star/deleted + externalDocs: + url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -57597,7 +58112,7 @@ x-webhooks: status: post: summary: |- - This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Statuses](https://docs.github.com/rest/reference/commits#commit-statuses)" in the REST API documentation. + This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. operationId: status @@ -58381,13 +58896,11 @@ x-webhooks: workflow-job-waiting: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. - - For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see [the REST API documentation](https://docs.github.com/rest/actions/workflow-jobs). + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. - For activity relating to a workflow run instead of a job in a workflow run, see the `workflow_run` event. + For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. - To install this event on a GitHub App, the app must have at least read-level access for the Actions metadata permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. description: A job in a workflow run was created and is waiting for approvals. operationId: workflow-job/waiting externalDocs: @@ -59018,8 +59531,9 @@ components: nvd_published_at: type: string format: date-time - description: The date and time of when the advisory was published in the - National Vulnerability Database, in ISO 8601 format. + description: |- + The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. + This field is only populated when the advisory is imported from the National Vulnerability Database. readOnly: true nullable: true withdrawn_at: @@ -63278,6 +63792,12 @@ components: type: string example: - 192.0.2.1 + github_enterprise_importer: + type: array + items: + type: string + example: + - 192.0.2.1 web: type: array items: @@ -64744,7 +65264,7 @@ components: type: string description: The display name of the machine includes cores, memory, and storage. - example: 4 cores, 8 GB RAM, 64 GB storage + example: 4 cores, 16 GB RAM, 64 GB storage operating_system: type: string description: The operating system of the machine. @@ -64756,7 +65276,7 @@ components: memory_in_bytes: type: integer description: How much memory is available to the codespace. - example: 8589934592 + example: 17179869184 cpus: type: integer description: How many cores are available to the codespace. @@ -67033,6 +67553,299 @@ components: updated_at: type: string format: date-time + repository-advisory-vulnerability: + description: A product affected by the vulnerability detailed in a repository + security advisory. + type: object + properties: + package: + description: The name of the package affected by the vulnerability. + type: object + nullable: true + properties: + ecosystem: + "$ref": "#/components/schemas/security-advisory-ecosystems" + name: + type: string + description: The unique package name within its ecosystem. + nullable: true + required: + - ecosystem + - name + vulnerable_version_range: + type: string + description: The range of the package versions affected by the vulnerability. + nullable: true + patched_versions: + type: string + description: The package version(s) that resolve the vulnerability. + nullable: true + vulnerable_functions: + type: array + description: The functions in the package that are affected. + nullable: true + items: + type: string + required: + - package + - vulnerable_version_range + - patched_versions + - vulnerable_functions + additionalProperties: false + repository-advisory-credit: + description: A credit given to a user for a repository security advisory. + type: object + properties: + user: + "$ref": "#/components/schemas/simple-user" + type: + "$ref": "#/components/schemas/security-advisory-credit-types" + state: + type: string + description: The state of the user's acceptance of the credit. + enum: + - accepted + - declined + - pending + required: + - user + - type + - state + additionalProperties: false + repository-advisory: + description: A repository security advisory. + type: object + properties: + ghsa_id: + type: string + description: The GitHub Security Advisory ID. + readOnly: true + cve_id: + type: string + description: The Common Vulnerabilities and Exposures (CVE) ID. + nullable: true + url: + type: string + description: The API URL for the advisory. + html_url: + type: string + format: uri + description: The URL for the advisory. + readOnly: true + summary: + type: string + description: A short summary of the advisory. + maxLength: 1024 + description: + type: string + description: A detailed description of what the advisory entails. + maxLength: 65535 + nullable: true + severity: + type: string + description: The severity of the advisory. + nullable: true + enum: + - critical + - high + - medium + - low + author: + readOnly: true + nullable: true + description: The author of the advisory. + allOf: + - "$ref": "#/components/schemas/simple-user" + publisher: + readOnly: true + nullable: true + description: The publisher of the advisory. + allOf: + - "$ref": "#/components/schemas/simple-user" + identifiers: + type: array + items: + type: object + properties: + type: + type: string + description: The type of identifier. + enum: + - CVE + - GHSA + value: + type: string + description: The identifier value. + required: + - type + - value + readOnly: true + state: + type: string + description: The state of the advisory. + enum: + - published + - closed + - withdrawn + - draft + - triage + created_at: + type: string + format: date-time + description: The date and time of when the advisory was created, in ISO + 8601 format. + readOnly: true + nullable: true + updated_at: + type: string + format: date-time + description: The date and time of when the advisory was last updated, in + ISO 8601 format. + readOnly: true + nullable: true + published_at: + type: string + format: date-time + description: The date and time of when the advisory was published, in ISO + 8601 format. + readOnly: true + nullable: true + closed_at: + type: string + format: date-time + description: The date and time of when the advisory was closed, in ISO 8601 + format. + readOnly: true + nullable: true + withdrawn_at: + type: string + format: date-time + description: The date and time of when the advisory was withdrawn, in ISO + 8601 format. + readOnly: true + nullable: true + submission: + type: object + nullable: true + readOnly: true + properties: + accepted: + type: boolean + description: Whether a private vulnerability report was accepted by + the repository's administrators. + readOnly: true + required: + - accepted + vulnerabilities: + type: array + nullable: true + items: + "$ref": "#/components/schemas/repository-advisory-vulnerability" + cvss: + type: object + nullable: true + properties: + vector_string: + type: string + description: The CVSS vector. + nullable: true + score: + type: number + description: The CVSS score. + minimum: 0 + maximum: 10 + nullable: true + readOnly: true + required: + - vector_string + - score + cwes: + type: array + nullable: true + items: + type: object + properties: + cwe_id: + type: string + description: The Common Weakness Enumeration (CWE) identifier. + name: + type: string + description: The name of the CWE. + readOnly: true + required: + - cwe_id + - name + readOnly: true + cwe_ids: + type: array + description: A list of only the CWE IDs. + nullable: true + items: + type: string + credits: + type: array + nullable: true + items: + type: object + properties: + login: + type: string + description: The username of the user credited. + type: + "$ref": "#/components/schemas/security-advisory-credit-types" + credits_detailed: + type: array + nullable: true + items: + "$ref": "#/components/schemas/repository-advisory-credit" + readOnly: true + collaborating_users: + type: array + description: A list of users that collaborate on the advisory. + nullable: true + items: + "$ref": "#/components/schemas/simple-user" + collaborating_teams: + type: array + description: A list of teams that collaborate on the advisory. + nullable: true + items: + "$ref": "#/components/schemas/team" + private_fork: + readOnly: true + nullable: true + description: A temporary private fork of the advisory's repository for collaborating + on a fix. + allOf: + - "$ref": "#/components/schemas/simple-repository" + required: + - ghsa_id + - cve_id + - url + - html_url + - summary + - description + - severity + - author + - publisher + - identifiers + - state + - created_at + - updated_at + - published_at + - closed_at + - withdrawn_at + - submission + - vulnerabilities + - cvss + - cwes + - cwe_ids + - credits + - credits_detailed + - collaborating_users + - collaborating_teams + - private_fork + additionalProperties: false team-simple: title: Team Simple description: Groups of organization members that gives permissions on specified @@ -72419,6 +73232,12 @@ components: type: string format: date-time example: '2023-12-06T14:20:20.000Z' + schedule: + description: The frequency of the periodic analysis. + nullable: true + type: string + enum: + - weekly code-scanning-default-setup-update: description: Configuration for code scanning default setup. type: object @@ -72576,7 +73395,7 @@ components: type: string description: The display name of the machine includes cores, memory, and storage. - example: 4 cores, 8 GB RAM, 64 GB storage + example: 4 cores, 16 GB RAM, 64 GB storage operating_system: type: string description: The operating system of the machine. @@ -72588,7 +73407,7 @@ components: memory_in_bytes: type: integer description: How much memory is available to the codespace. - example: 8589934592 + example: 17179869184 cpus: type: integer description: How many cores are available to the codespace. @@ -79633,299 +80452,6 @@ components: required: - type - details - repository-advisory-vulnerability: - description: A product affected by the vulnerability detailed in a repository - security advisory. - type: object - properties: - package: - description: The name of the package affected by the vulnerability. - type: object - nullable: true - properties: - ecosystem: - "$ref": "#/components/schemas/security-advisory-ecosystems" - name: - type: string - description: The unique package name within its ecosystem. - nullable: true - required: - - ecosystem - - name - vulnerable_version_range: - type: string - description: The range of the package versions affected by the vulnerability. - nullable: true - patched_versions: - type: string - description: The package version(s) that resolve the vulnerability. - nullable: true - vulnerable_functions: - type: array - description: The functions in the package that are affected. - nullable: true - items: - type: string - required: - - package - - vulnerable_version_range - - patched_versions - - vulnerable_functions - additionalProperties: false - repository-advisory-credit: - description: A credit given to a user for a repository security advisory. - type: object - properties: - user: - "$ref": "#/components/schemas/simple-user" - type: - "$ref": "#/components/schemas/security-advisory-credit-types" - state: - type: string - description: The state of the user's acceptance of the credit. - enum: - - accepted - - declined - - pending - required: - - user - - type - - state - additionalProperties: false - repository-advisory: - description: A repository security advisory. - type: object - properties: - ghsa_id: - type: string - description: The GitHub Security Advisory ID. - readOnly: true - cve_id: - type: string - description: The Common Vulnerabilities and Exposures (CVE) ID. - nullable: true - url: - type: string - description: The API URL for the advisory. - html_url: - type: string - format: uri - description: The URL for the advisory. - readOnly: true - summary: - type: string - description: A short summary of the advisory. - maxLength: 1024 - description: - type: string - description: A detailed description of what the advisory entails. - maxLength: 65535 - nullable: true - severity: - type: string - description: The severity of the advisory. - nullable: true - enum: - - critical - - high - - medium - - low - author: - readOnly: true - nullable: true - description: The author of the advisory. - allOf: - - "$ref": "#/components/schemas/simple-user" - publisher: - readOnly: true - nullable: true - description: The publisher of the advisory. - allOf: - - "$ref": "#/components/schemas/simple-user" - identifiers: - type: array - items: - type: object - properties: - type: - type: string - description: The type of identifier. - enum: - - CVE - - GHSA - value: - type: string - description: The identifier value. - required: - - type - - value - readOnly: true - state: - type: string - description: The state of the advisory. - enum: - - published - - closed - - withdrawn - - draft - - triage - created_at: - type: string - format: date-time - description: The date and time of when the advisory was created, in ISO - 8601 format. - readOnly: true - nullable: true - updated_at: - type: string - format: date-time - description: The date and time of when the advisory was last updated, in - ISO 8601 format. - readOnly: true - nullable: true - published_at: - type: string - format: date-time - description: The date and time of when the advisory was published, in ISO - 8601 format. - readOnly: true - nullable: true - closed_at: - type: string - format: date-time - description: The date and time of when the advisory was closed, in ISO 8601 - format. - readOnly: true - nullable: true - withdrawn_at: - type: string - format: date-time - description: The date and time of when the advisory was withdrawn, in ISO - 8601 format. - readOnly: true - nullable: true - submission: - type: object - nullable: true - readOnly: true - properties: - accepted: - type: boolean - description: Whether a private vulnerability report was accepted by - the repository's administrators. - readOnly: true - required: - - accepted - vulnerabilities: - type: array - nullable: true - items: - "$ref": "#/components/schemas/repository-advisory-vulnerability" - cvss: - type: object - nullable: true - properties: - vector_string: - type: string - description: The CVSS vector. - nullable: true - score: - type: number - description: The CVSS score. - minimum: 0 - maximum: 10 - nullable: true - readOnly: true - required: - - vector_string - - score - cwes: - type: array - nullable: true - items: - type: object - properties: - cwe_id: - type: string - description: The Common Weakness Enumeration (CWE) identifier. - name: - type: string - description: The name of the CWE. - readOnly: true - required: - - cwe_id - - name - readOnly: true - cwe_ids: - type: array - description: A list of only the CWE IDs. - nullable: true - items: - type: string - credits: - type: array - nullable: true - items: - type: object - properties: - login: - type: string - description: The username of the user credited. - type: - "$ref": "#/components/schemas/security-advisory-credit-types" - credits_detailed: - type: array - nullable: true - items: - "$ref": "#/components/schemas/repository-advisory-credit" - readOnly: true - collaborating_users: - type: array - description: A list of users that collaborate on the advisory. - nullable: true - items: - "$ref": "#/components/schemas/simple-user" - collaborating_teams: - type: array - description: A list of teams that collaborate on the advisory. - nullable: true - items: - "$ref": "#/components/schemas/team" - private_fork: - readOnly: true - nullable: true - description: A temporary private fork of the advisory's repository for collaborating - on a fix. - allOf: - - "$ref": "#/components/schemas/simple-repository" - required: - - ghsa_id - - cve_id - - url - - html_url - - summary - - description - - severity - - author - - publisher - - identifiers - - state - - created_at - - updated_at - - published_at - - closed_at - - withdrawn_at - - submission - - vulnerabilities - - cvss - - cwes - - cwe_ids - - credits - - credits_detailed - - collaborating_users - - collaborating_teams - - private_fork - additionalProperties: false repository-advisory-create: type: object properties: @@ -83694,7 +84220,7 @@ components: enum: - completed check_suite: - description: The [check_suite](https://docs.github.com/rest/reference/checks#suites). + description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). type: object properties: after: @@ -84293,7 +84819,7 @@ components: enum: - requested check_suite: - description: The [check_suite](https://docs.github.com/rest/reference/checks#suites). + description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). type: object properties: after: @@ -84891,7 +85417,7 @@ components: enum: - rerequested check_suite: - description: The [check_suite](https://docs.github.com/rest/reference/checks#suites). + description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). type: object properties: after: @@ -86877,7 +87403,7 @@ components: enum: - created comment: - description: The [commit comment](https://docs.github.com/rest/reference/repos#get-a-commit-comment) + description: The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. type: object properties: @@ -87326,7 +87852,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" key: - description: The [`deploy key`](https://docs.github.com/rest/reference/deployments#get-a-deploy-key) + description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object properties: @@ -87383,7 +87909,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" key: - description: The [`deploy key`](https://docs.github.com/rest/reference/deployments#get-a-deploy-key) + description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object properties: @@ -87437,7 +87963,7 @@ components: - created deployment: title: Deployment - description: The [deployment](https://docs.github.com/rest/reference/deployments#list-deployments). + description: The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). type: object properties: created_at: @@ -88595,6 +89121,2387 @@ components: "$ref": "#/components/schemas/simple-installation" sender: "$ref": "#/components/schemas/simple-user" + webhook-deployment-review-approved: + type: object + properties: + action: + type: string + enum: + - approved + approver: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + comment: + type: string + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + reviewers: + type: array + items: + type: object + properties: + reviewer: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + type: + type: string + enum: + - User + sender: + "$ref": "#/components/schemas/simple-user" + since: + type: string + workflow_job_run: + type: object + properties: + conclusion: + nullable: true + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + nullable: true + status: + type: string + updated_at: + type: string + required: + - id + - name + - status + - conclusion + - html_url + - created_at + - updated_at + - environment + workflow_job_runs: + type: array + items: + type: object + properties: + conclusion: + nullable: true + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: string + nullable: true + status: + type: string + updated_at: + type: string + workflow_run: + title: Deployment Workflow Run + type: object + nullable: true + properties: + actor: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + artifacts_url: + type: string + cancel_url: + type: string + check_suite_id: + type: integer + check_suite_node_id: + type: string + check_suite_url: + type: string + conclusion: + type: string + nullable: true + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + display_title: + type: string + event: + type: string + head_branch: + type: string + head_commit: + type: object + nullable: true + head_repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: string + nullable: true + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + head_sha: + type: string + html_url: + type: string + format: uri + id: + type: integer + jobs_url: + type: string + logs_url: + type: string + name: + type: string + node_id: + type: string + path: + type: string + previous_attempt_url: + type: string + nullable: true + pull_requests: + type: array + items: + title: Check Run Pull Request + type: object + properties: + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + id: + type: integer + number: + type: integer + url: + type: string + format: uri + required: + - url + - id + - number + - head + - base + referenced_workflows: + type: array + nullable: true + items: + type: object + properties: + path: + type: string + ref: + type: string + sha: + type: string + required: + - path + - sha + repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: string + nullable: true + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + rerun_url: + type: string + run_attempt: + type: integer + run_number: + type: integer + run_started_at: + type: string + format: date-time + status: + type: string + enum: + - requested + - in_progress + - completed + - queued + - waiting + - pending + triggering_actor: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string + required: + - id + - name + - node_id + - head_branch + - head_sha + - run_number + - event + - status + - conclusion + - workflow_id + - check_suite_id + - check_suite_node_id + - url + - html_url + - path + - pull_requests + - created_at + - updated_at + - actor + - triggering_actor + - run_attempt + - run_started_at + - display_title + required: + - action + - workflow_run + - since + - repository + - organization + - sender + webhook-deployment-review-rejected: + type: object + properties: + action: + type: string + enum: + - rejected + approver: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + comment: + type: string + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + reviewers: + type: array + items: + type: object + properties: + reviewer: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + type: + type: string + enum: + - User + sender: + "$ref": "#/components/schemas/simple-user" + since: + type: string + workflow_job_run: + type: object + properties: + conclusion: + nullable: true + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + nullable: true + status: + type: string + updated_at: + type: string + required: + - id + - name + - status + - conclusion + - html_url + - created_at + - updated_at + - environment + workflow_job_runs: + type: array + items: + type: object + properties: + conclusion: + type: string + nullable: true + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: string + nullable: true + status: + type: string + updated_at: + type: string + workflow_run: + title: Deployment Workflow Run + type: object + nullable: true + properties: + actor: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + artifacts_url: + type: string + cancel_url: + type: string + check_suite_id: + type: integer + check_suite_node_id: + type: string + check_suite_url: + type: string + conclusion: + type: string + nullable: true + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + event: + type: string + head_branch: + type: string + head_commit: + type: object + nullable: true + head_repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: string + nullable: true + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + head_sha: + type: string + html_url: + type: string + format: uri + id: + type: integer + jobs_url: + type: string + logs_url: + type: string + name: + type: string + node_id: + type: string + path: + type: string + previous_attempt_url: + type: string + nullable: true + pull_requests: + type: array + items: + title: Check Run Pull Request + type: object + properties: + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + id: + type: integer + number: + type: integer + url: + type: string + format: uri + required: + - url + - id + - number + - head + - base + referenced_workflows: + type: array + nullable: true + items: + type: object + properties: + path: + type: string + ref: + type: string + sha: + type: string + required: + - path + - sha + repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: string + nullable: true + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + rerun_url: + type: string + run_attempt: + type: integer + run_number: + type: integer + run_started_at: + type: string + format: date-time + status: + type: string + enum: + - requested + - in_progress + - completed + - queued + - waiting + triggering_actor: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string + display_title: + type: string + required: + - id + - name + - node_id + - head_branch + - head_sha + - run_number + - event + - status + - conclusion + - workflow_id + - check_suite_id + - check_suite_node_id + - url + - html_url + - path + - pull_requests + - created_at + - updated_at + - actor + - triggering_actor + - run_attempt + - run_started_at + - display_title + required: + - action + - workflow_run + - since + - repository + - organization + - sender + webhook-deployment-review-requested: + type: object + properties: + action: + type: string + enum: + - requested + enterprise: + "$ref": "#/components/schemas/enterprise" + environment: + type: string + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + requestor: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + reviewers: + type: array + items: + type: object + properties: + reviewer: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - id + type: + type: string + enum: + - User + - Team + sender: + "$ref": "#/components/schemas/simple-user" + since: + type: string + workflow_job_run: + type: object + properties: + conclusion: + nullable: true + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: string + nullable: true + status: + type: string + updated_at: + type: string + required: + - id + - name + - status + - conclusion + - html_url + - created_at + - updated_at + - environment + workflow_run: + title: Deployment Workflow Run + type: object + nullable: true + properties: + actor: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + artifacts_url: + type: string + cancel_url: + type: string + check_suite_id: + type: integer + check_suite_node_id: + type: string + check_suite_url: + type: string + conclusion: + type: string + nullable: true + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + event: + type: string + head_branch: + type: string + head_commit: + type: object + nullable: true + head_repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: string + nullable: true + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + head_sha: + type: string + html_url: + type: string + format: uri + id: + type: integer + jobs_url: + type: string + logs_url: + type: string + name: + type: string + node_id: + type: string + path: + type: string + previous_attempt_url: + type: string + nullable: true + pull_requests: + type: array + items: + title: Check Run Pull Request + type: object + properties: + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + id: + type: integer + number: + type: integer + url: + type: string + format: uri + required: + - url + - id + - number + - head + - base + referenced_workflows: + type: array + nullable: true + items: + type: object + properties: + path: + type: string + ref: + type: string + sha: + type: string + required: + - path + - sha + repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: string + nullable: true + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + rerun_url: + type: string + run_attempt: + type: integer + run_number: + type: integer + run_started_at: + type: string + format: date-time + status: + type: string + enum: + - requested + - in_progress + - completed + - queued + - waiting + - pending + triggering_actor: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string + display_title: + type: string + required: + - id + - name + - node_id + - head_branch + - head_sha + - run_number + - event + - status + - conclusion + - workflow_id + - check_suite_id + - check_suite_node_id + - url + - html_url + - path + - pull_requests + - created_at + - updated_at + - actor + - triggering_actor + - run_attempt + - run_started_at + - display_title + required: + - action + - workflow_run + - since + - workflow_job_run + - environment + - reviewers + - requestor + - repository + - organization + - sender webhook-deployment-status-created: title: deployment_status created event type: object @@ -88677,7 +91584,7 @@ components: - completed_at deployment: title: Deployment - description: The [deployment](https://docs.github.com/rest/reference/deployments#list-deployments). + description: The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). type: object properties: created_at: @@ -89154,7 +92061,7 @@ components: - statuses_url - repository_url deployment_status: - description: The [deployment status](https://docs.github.com/rest/reference/deployments#list-deployment-statuses). + description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). type: object properties: created_at: @@ -93459,6 +96366,8 @@ components: - html_url action: type: string + enum: + - renamed changes: type: object properties: @@ -93553,7 +96462,7 @@ components: - created comment: title: issue comment - description: The [comment](https://docs.github.com/rest/reference/issues#comments) + description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. type: object properties: @@ -93718,11 +96627,11 @@ components: installation: "$ref": "#/components/schemas/simple-installation" issue: - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -94865,7 +97774,7 @@ components: - deleted comment: title: issue comment - description: The [comment](https://docs.github.com/rest/reference/issues#comments) + description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. type: object properties: @@ -95031,11 +97940,11 @@ components: installation: "$ref": "#/components/schemas/simple-installation" issue: - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -96186,7 +99095,7 @@ components: - from comment: title: issue comment - description: The [comment](https://docs.github.com/rest/reference/issues#comments) + description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. type: object properties: @@ -96352,11 +99261,11 @@ components: installation: "$ref": "#/components/schemas/simple-installation" issue: - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -97571,7 +100480,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -98486,11 +101395,11 @@ components: installation: "$ref": "#/components/schemas/simple-installation" issue: - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -99539,7 +102448,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -100449,7 +103358,7 @@ components: issue: allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -101781,7 +104690,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -102730,7 +105639,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -103678,7 +106587,7 @@ components: issue: allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -104727,7 +107636,7 @@ components: issue: allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -106036,7 +108945,7 @@ components: properties: old_issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object nullable: true @@ -107377,7 +110286,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -108290,7 +111199,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -109199,7 +112108,7 @@ components: issue: allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -110245,7 +113154,7 @@ components: properties: new_issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -111594,7 +114503,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -112572,7 +115481,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -113487,7 +116396,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -114435,7 +117344,7 @@ components: issue: allOf: - title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -115473,7 +118382,7 @@ components: "$ref": "#/components/schemas/simple-installation" issue: title: Issue - description: The [issue](https://docs.github.com/rest/reference/issues) + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object properties: @@ -121492,7 +124401,7 @@ components: type: object properties: build: - description: The [List GitHub Pages builds](https://docs.github.com/rest/reference/repos#list-github-pages-builds) + description: The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. type: object properties: @@ -145012,7 +147921,7 @@ components: - created comment: title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/reference/pulls#comments) + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -147449,7 +150358,7 @@ components: - deleted comment: title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/reference/pulls#comments) + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -149885,7 +152794,7 @@ components: - from comment: title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/reference/pulls#comments) + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -170571,7 +173480,7 @@ components: type: array items: title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/reference/pulls#comments) + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -172908,7 +175817,7 @@ components: type: array items: title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/reference/pulls#comments) + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: @@ -182353,7 +185262,7 @@ components: description: An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum - of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/reference/repos#commits) + of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. type: array @@ -183568,6 +186477,8 @@ components: properties: action: type: string + enum: + - updated enterprise: "$ref": "#/components/schemas/enterprise" installation: @@ -183949,7 +186860,7 @@ components: "$ref": "#/components/schemas/organization-simple" release: title: Release - description: The [release](https://docs.github.com/rest/reference/repos/#get-a-release) + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. type: object properties: @@ -184275,7 +187186,7 @@ components: "$ref": "#/components/schemas/organization-simple" release: title: Release - description: The [release](https://docs.github.com/rest/reference/repos/#get-a-release) + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. type: object properties: @@ -184631,7 +187542,7 @@ components: "$ref": "#/components/schemas/organization-simple" release: title: Release - description: The [release](https://docs.github.com/rest/reference/repos/#get-a-release) + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. type: object properties: @@ -184958,7 +187869,7 @@ components: release: allOf: - title: Release - description: The [release](https://docs.github.com/rest/reference/repos/#get-a-release) + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. type: object properties: @@ -185373,7 +188284,7 @@ components: release: allOf: - title: Release - description: The [release](https://docs.github.com/rest/reference/repos/#get-a-release) + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. type: object properties: @@ -185784,7 +188695,7 @@ components: "$ref": "#/components/schemas/organization-simple" release: title: Release - description: The [release](https://docs.github.com/rest/reference/repos/#get-a-release) + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. type: object properties: @@ -186110,7 +189021,7 @@ components: release: allOf: - title: Release - description: The [release](https://docs.github.com/rest/reference/repos/#get-a-release) + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. type: object properties: @@ -186624,6 +189535,8 @@ components: properties: action: type: string + enum: + - sample.collected branch: type: string client_payload: @@ -186812,6 +189725,172 @@ components: - changes - repository - sender + webhook-repository-ruleset-created: + title: repository ruleset created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + repository_ruleset: + "$ref": "#/components/schemas/repository-ruleset" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - repository_ruleset + - sender + webhook-repository-ruleset-deleted: + title: repository ruleset deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + repository_ruleset: + "$ref": "#/components/schemas/repository-ruleset" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - repository_ruleset + - sender + webhook-repository-ruleset-edited: + title: repository ruleset edited event + type: object + properties: + action: + type: string + enum: + - edited + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + repository_ruleset: + "$ref": "#/components/schemas/repository-ruleset" + changes: + type: object + properties: + name: + type: object + properties: + from: + type: string + enforcement: + type: object + properties: + from: + type: string + conditions: + type: object + properties: + added: + type: array + items: + "$ref": "#/components/schemas/repository-ruleset-conditions" + deleted: + type: array + items: + "$ref": "#/components/schemas/repository-ruleset-conditions" + updated: + type: array + items: + type: object + properties: + condition: + "$ref": "#/components/schemas/repository-ruleset-conditions" + changes: + type: object + properties: + condition_type: + type: object + properties: + from: + type: string + target: + type: object + properties: + from: + type: string + include: + type: object + properties: + from: + type: array + items: + type: string + exclude: + type: object + properties: + from: + type: array + items: + type: string + rules: + type: object + properties: + added: + type: array + items: + "$ref": "#/components/schemas/repository-rule" + deleted: + type: array + items: + "$ref": "#/components/schemas/repository-rule" + updated: + type: array + items: + type: object + properties: + rule: + "$ref": "#/components/schemas/repository-rule" + changes: + type: object + properties: + configuration: + type: object + properties: + from: + type: string + rule_type: + type: object + properties: + from: + type: string + pattern: + type: object + properties: + from: + type: string + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - repository_ruleset + - sender webhook-repository-transferred: title: repository transferred event type: object @@ -202443,6 +205522,8 @@ components: - ssh-rsa ABCDEFGHIJKLMNOPQRSTUVWXYZ hooks: - 192.0.2.1 + github_enterprise_importer: + - 192.0.2.1 web: - 192.0.2.1 api: @@ -202790,8 +205871,8 @@ components: advanced_security_enabled_for_new_repositories: false secret_scanning_enabled_for_new_repositories: false secret_scanning_push_protection_enabled_for_new_repositories: false - secret_scanning_push_protection_custom_link: false - secret_scanning_push_protection_custom_link_enabled: https://github.com/octo-org/octo-repo/blob/main/im-blocked.md + secret_scanning_push_protection_custom_link: https://github.com/octo-org/octo-repo/blob/main/im-blocked.md + secret_scanning_push_protection_custom_link_enabled: false actions-cache-usage-org-enterprise: value: total_active_caches_size_in_bytes: 3344284 @@ -203575,10 +206656,10 @@ components: hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks machine: name: standardLinux - display_name: 4 cores, 8 GB RAM, 64 GB storage + display_name: 4 cores, 16 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 8589934592 + memory_in_bytes: 17179869184 cpus: 4 prebuild: false devcontainer_path: ".devcontainer/devcontainer.json" @@ -203710,10 +206791,10 @@ components: hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks machine: name: standardLinux - display_name: 4 cores, 8 GB RAM, 64 GB storage + display_name: 4 cores, 16 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 8589934592 + memory_in_bytes: 17179869184 cpus: 4 prebuild: false devcontainer_path: ".devcontainer/foobar/devcontainer.json" @@ -203845,10 +206926,10 @@ components: hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks machine: name: standardLinux - display_name: 4 cores, 8 GB RAM, 64 GB storage + display_name: 4 cores, 16 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 8589934592 + memory_in_bytes: 17179869184 cpus: 4 prebuild: false devcontainer_path: ".devcontainer.json" @@ -204443,10 +207524,10 @@ components: hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks machine: name: standardLinux - display_name: 4 cores, 8 GB RAM, 64 GB storage + display_name: 4 cores, 16 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 8589934592 + memory_in_bytes: 17179869184 cpus: 4 prebuild: false devcontainer_path: ".devcontainer/devcontainer.json" @@ -205495,6 +208576,285 @@ components: href: https://github.com/organizations/my-org/settings/rules/21 created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' + list-repository-advisories: + value: + - ghsa_id: GHSA-abcd-1234-efgh + cve_id: CVE-2050-00000 + url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh + html_url: https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh + summary: A short summary of the advisory. + description: A detailed description of what the advisory entails. + severity: critical + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + publisher: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + identifiers: + - type: GHSA + value: GHSA-abcd-1234-efgh + - type: CVE + value: CVE-2050-00000 + state: published + created_at: '2020-01-01T00:00:00Z' + updated_at: '2020-01-02T00:00:00Z' + published_at: '2020-01-03T00:00:00Z' + closed_at: + withdrawn_at: + submission: + vulnerabilities: + - package: + ecosystem: pip + name: a-package + vulnerable_version_range: ">= 1.0.0, < 1.0.1" + patched_versions: 1.0.1 + vulnerable_functions: + - function1 + - package: + ecosystem: pip + name: another-package + vulnerable_version_range: ">= 1.0.0, < 1.0.2" + patched_versions: 1.0.2 + vulnerable_functions: + - function2 + cvss: + vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H + score: 9.8 + cwes: + - cwe_id: CWE-123 + name: A CWE + cwe_ids: + - CWE-123 + credits: + - login: octocat + type: analyst + credits_detailed: + - user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + type: analyst + state: accepted + collaborating_users: + - login: octokitten + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + received_events_url: https://api.github.com/users/octokitten/received_events + type: User + site_admin: false + collaborating_teams: + - name: Justice League + id: 1 + node_id: MDQ6VGVhbTE= + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + permission: admin + parent: + - ghsa_id: GHSA-1234-5678-9012 + cve_id: CVE-2051-0000 + url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012 + html_url: https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012 + summary: A short summary of the advisory. + description: A detailed description of what the advisory entails. + severity: low + author: + login: monauser + id: 2 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monauser + html_url: https://github.com/monauser + followers_url: https://api.github.com/users/monauser/followers + following_url: https://api.github.com/users/monauser/following{/other_user} + gists_url: https://api.github.com/users/monauser/gists{/gist_id} + starred_url: https://api.github.com/users/monauser/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monauser/subscriptions + organizations_url: https://api.github.com/users/monauser/orgs + repos_url: https://api.github.com/users/monauser/repos + events_url: https://api.github.com/users/monauser/events{/privacy} + received_events_url: https://api.github.com/users/monauser/received_events + type: User + site_admin: false + publisher: + login: monalisa + id: 3 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: false + identifiers: + - type: GHSA + value: GHSA-1234-5678-9012 + - type: CVE + value: CVE-2051-00000 + state: published + created_at: '2020-01-03T00:00:00Z' + updated_at: '2020-01-04T00:00:00Z' + published_at: '2020-01-04T00:00:00Z' + closed_at: + withdrawn_at: + submission: + - accepted: true + vulnerabilities: + - package: + ecosystem: pip + name: a-package + vulnerable_version_range: ">= 1.0.0, < 1.0.1" + patched_versions: 1.0.1 + vulnerable_functions: + - function1 + - package: + ecosystem: pip + name: another-package + vulnerable_version_range: ">= 1.0.0, < 1.0.2" + patched_versions: 1.0.2 + vulnerable_functions: + - function2 + cvss: + vector_string: AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N + score: 1.6 + cwes: + - cwe_id: CWE-456 + name: A CWE 2.0 + cwe_ids: + - CWE-456 + credits: + - login: monauser + type: reporter + credits_detailed: + - user: + login: monauser + id: 2 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monauser + html_url: https://github.com/monauser + followers_url: https://api.github.com/users/monauser/followers + following_url: https://api.github.com/users/monauser/following{/other_user} + gists_url: https://api.github.com/users/monauser/gists{/gist_id} + starred_url: https://api.github.com/users/monauser/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monauser/subscriptions + organizations_url: https://api.github.com/users/monauser/orgs + repos_url: https://api.github.com/users/monauser/repos + events_url: https://api.github.com/users/monauser/events{/privacy} + received_events_url: https://api.github.com/users/monauser/received_events + type: User + site_admin: false + type: reporter + state: accepted + collaborating_users: + - login: octokitten + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + received_events_url: https://api.github.com/users/octokitten/received_events + type: User + site_admin: false + collaborating_teams: + - name: Justice League + id: 1 + node_id: MDQ6VGVhbTE= + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + permission: admin + parent: actions-billing-usage: value: total_minutes_used: 305 @@ -206384,34 +209744,59 @@ components: resources: core: limit: 5000 - remaining: 4999 - reset: 1372700873 used: 1 + remaining: 4999 + reset: 1691591363 search: limit: 30 - remaining: 18 - reset: 1372697452 used: 12 + remaining: 18 + reset: 1691591091 graphql: limit: 5000 - remaining: 4993 - reset: 1372700389 used: 7 + remaining: 4993 + reset: 1691593228 integration_manifest: limit: 5000 + used: 1 remaining: 4999 - reset: 1551806725 + reset: 1691594631 + source_import: + limit: 100 used: 1 + remaining: 99 + reset: 1691591091 code_scanning_upload: limit: 500 - remaining: 499 - reset: 1551806725 used: 1 + remaining: 499 + reset: 1691594631 + actions_runner_registration: + limit: 10000 + used: 0 + remaining: 10000 + reset: 1691594631 + scim: + limit: 15000 + used: 0 + remaining: 15000 + reset: 1691594631 + dependency_snapshots: + limit: 100 + used: 0 + remaining: 100 + reset: 1691591091 + code_search: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 + used: 1 remaining: 4999 reset: 1372700873 - used: 1 full-repository-default-response: summary: Default response value: @@ -210257,6 +213642,7 @@ components: - python query_suite: default updated_at: '2023-01-19T11:21:34Z' + schedule: weekly code-scanning-default-setup-update: value: state: configured @@ -210413,10 +213799,10 @@ components: hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks machine: name: standardLinux - display_name: 4 cores, 8 GB RAM, 64 GB storage + display_name: 4 cores, 16 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 8589934592 + memory_in_bytes: 17179869184 cpus: 4 prebuild: false devcontainer_path: ".devcontainer/devcontainer.json" @@ -210548,10 +213934,10 @@ components: hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks machine: name: standardLinux - display_name: 4 cores, 8 GB RAM, 64 GB storage + display_name: 4 cores, 16 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 8589934592 + memory_in_bytes: 17179869184 cpus: 4 prebuild: false devcontainer_path: ".devcontainer/devcontainer.json" @@ -210590,16 +213976,16 @@ components: total_count: 2 machines: - name: standardLinux - display_name: 4 cores, 8 GB RAM, 64 GB storage + display_name: 4 cores, 16 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 8589934592 + memory_in_bytes: 17179869184 cpus: 4 - name: premiumLinux - display_name: 8 cores, 16 GB RAM, 64 GB storage + display_name: 8 cores, 32 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 17179869184 + memory_in_bytes: 34359738368 cpus: 8 collaborator-items: value: @@ -217475,285 +220861,6 @@ components: - type: issue_comment details: issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - list-repository-advisories: - value: - - ghsa_id: GHSA-abcd-1234-efgh - cve_id: CVE-2050-00000 - url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh - html_url: https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh - summary: A short summary of the advisory. - description: A detailed description of what the advisory entails. - severity: critical - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - publisher: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - identifiers: - - type: GHSA - value: GHSA-abcd-1234-efgh - - type: CVE - value: CVE-2050-00000 - state: published - created_at: '2020-01-01T00:00:00Z' - updated_at: '2020-01-02T00:00:00Z' - published_at: '2020-01-03T00:00:00Z' - closed_at: - withdrawn_at: - submission: - vulnerabilities: - - package: - ecosystem: pip - name: a-package - vulnerable_version_range: ">= 1.0.0, < 1.0.1" - patched_versions: 1.0.1 - vulnerable_functions: - - function1 - - package: - ecosystem: pip - name: another-package - vulnerable_version_range: ">= 1.0.0, < 1.0.2" - patched_versions: 1.0.2 - vulnerable_functions: - - function2 - cvss: - vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H - score: 9.8 - cwes: - - cwe_id: CWE-123 - name: A CWE - cwe_ids: - - CWE-123 - credits: - - login: octocat - type: analyst - credits_detailed: - - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - type: analyst - state: accepted - collaborating_users: - - login: octokitten - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octokitten_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octokitten - html_url: https://github.com/octokitten - followers_url: https://api.github.com/users/octokitten/followers - following_url: https://api.github.com/users/octokitten/following{/other_user} - gists_url: https://api.github.com/users/octokitten/gists{/gist_id} - starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octokitten/subscriptions - organizations_url: https://api.github.com/users/octokitten/orgs - repos_url: https://api.github.com/users/octokitten/repos - events_url: https://api.github.com/users/octokitten/events{/privacy} - received_events_url: https://api.github.com/users/octokitten/received_events - type: User - site_admin: false - collaborating_teams: - - name: Justice League - id: 1 - node_id: MDQ6VGVhbTE= - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - permission: admin - parent: - - ghsa_id: GHSA-1234-5678-9012 - cve_id: CVE-2051-0000 - url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012 - html_url: https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012 - summary: A short summary of the advisory. - description: A detailed description of what the advisory entails. - severity: low - author: - login: monauser - id: 2 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/monauser - html_url: https://github.com/monauser - followers_url: https://api.github.com/users/monauser/followers - following_url: https://api.github.com/users/monauser/following{/other_user} - gists_url: https://api.github.com/users/monauser/gists{/gist_id} - starred_url: https://api.github.com/users/monauser/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monauser/subscriptions - organizations_url: https://api.github.com/users/monauser/orgs - repos_url: https://api.github.com/users/monauser/repos - events_url: https://api.github.com/users/monauser/events{/privacy} - received_events_url: https://api.github.com/users/monauser/received_events - type: User - site_admin: false - publisher: - login: monalisa - id: 3 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: false - identifiers: - - type: GHSA - value: GHSA-1234-5678-9012 - - type: CVE - value: CVE-2051-00000 - state: published - created_at: '2020-01-03T00:00:00Z' - updated_at: '2020-01-04T00:00:00Z' - published_at: '2020-01-04T00:00:00Z' - closed_at: - withdrawn_at: - submission: - - accepted: true - vulnerabilities: - - package: - ecosystem: pip - name: a-package - vulnerable_version_range: ">= 1.0.0, < 1.0.1" - patched_versions: 1.0.1 - vulnerable_functions: - - function1 - - package: - ecosystem: pip - name: another-package - vulnerable_version_range: ">= 1.0.0, < 1.0.2" - patched_versions: 1.0.2 - vulnerable_functions: - - function2 - cvss: - vector_string: AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N - score: 1.6 - cwes: - - cwe_id: CWE-456 - name: A CWE 2.0 - cwe_ids: - - CWE-456 - credits: - - login: monauser - type: reporter - credits_detailed: - - user: - login: monauser - id: 2 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/monauser - html_url: https://github.com/monauser - followers_url: https://api.github.com/users/monauser/followers - following_url: https://api.github.com/users/monauser/following{/other_user} - gists_url: https://api.github.com/users/monauser/gists{/gist_id} - starred_url: https://api.github.com/users/monauser/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monauser/subscriptions - organizations_url: https://api.github.com/users/monauser/orgs - repos_url: https://api.github.com/users/monauser/repos - events_url: https://api.github.com/users/monauser/events{/privacy} - received_events_url: https://api.github.com/users/monauser/received_events - type: User - site_admin: false - type: reporter - state: accepted - collaborating_users: - - login: octokitten - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octokitten_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octokitten - html_url: https://github.com/octokitten - followers_url: https://api.github.com/users/octokitten/followers - following_url: https://api.github.com/users/octokitten/following{/other_user} - gists_url: https://api.github.com/users/octokitten/gists{/gist_id} - starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octokitten/subscriptions - organizations_url: https://api.github.com/users/octokitten/orgs - repos_url: https://api.github.com/users/octokitten/repos - events_url: https://api.github.com/users/octokitten/events{/privacy} - received_events_url: https://api.github.com/users/octokitten/received_events - type: User - site_admin: false - collaborating_teams: - - name: Justice League - id: 1 - node_id: MDQ6VGVhbTE= - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - permission: admin - parent: repository-advisory: value: ghsa_id: GHSA-abcd-1234-efgh @@ -220512,10 +223619,10 @@ components: watchers: 1 machine: name: standardLinux - display_name: 4 cores, 8 GB RAM, 64 GB storage + display_name: 4 cores, 16 GB RAM, 64 GB storage operating_system: linux storage_in_bytes: 68719476736 - memory_in_bytes: 8589934592 + memory_in_bytes: 17179869184 cpus: 4 prebuild: false devcontainer_path: ".devcontainer/devcontainer.json" diff --git a/packages/openapi-typescript/examples/stripe-api.ts b/packages/openapi-typescript/examples/stripe-api.ts index efd9ef4a3..598dc472f 100644 --- a/packages/openapi-typescript/examples/stripe-api.ts +++ b/packages/openapi-typescript/examples/stripe-api.ts @@ -38,7 +38,7 @@ export interface paths { * for a Standard or Express account, some parameters can no longer be changed. These are marked as Custom Only or Custom and Express * below.

* - *

To update your own account, use the Dashboard. Refer to our + *

To update your own account, use the Dashboard. Refer to our * Connect documentation to learn more about updating accounts.

*/ post: operations["PostAccountsAccount"]; @@ -47,7 +47,7 @@ export interface paths { * *

Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.

* - *

If you want to delete your own account, use the account information tab in your account settings instead.

+ *

If you want to delete your own account, use the account information tab in your account settings instead.

*/ delete: operations["DeleteAccountsAccount"]; }; @@ -2497,7 +2497,7 @@ export interface components { * @description The code for the type of error. * @enum {string} */ - code: "invalid_address_city_state_postal_code" | "invalid_dob_age_under_18" | "invalid_representative_country" | "invalid_street_address" | "invalid_tos_acceptance" | "invalid_value_other" | "verification_document_address_mismatch" | "verification_document_address_missing" | "verification_document_corrupt" | "verification_document_country_not_supported" | "verification_document_dob_mismatch" | "verification_document_duplicate_type" | "verification_document_expired" | "verification_document_failed_copy" | "verification_document_failed_greyscale" | "verification_document_failed_other" | "verification_document_failed_test_mode" | "verification_document_fraudulent" | "verification_document_id_number_mismatch" | "verification_document_id_number_missing" | "verification_document_incomplete" | "verification_document_invalid" | "verification_document_issue_or_expiry_date_missing" | "verification_document_manipulated" | "verification_document_missing_back" | "verification_document_missing_front" | "verification_document_name_mismatch" | "verification_document_name_missing" | "verification_document_nationality_mismatch" | "verification_document_not_readable" | "verification_document_not_signed" | "verification_document_not_uploaded" | "verification_document_photo_mismatch" | "verification_document_too_large" | "verification_document_type_not_supported" | "verification_failed_address_match" | "verification_failed_business_iec_number" | "verification_failed_document_match" | "verification_failed_id_number_match" | "verification_failed_keyed_identity" | "verification_failed_keyed_match" | "verification_failed_name_match" | "verification_failed_other" | "verification_failed_residential_address" | "verification_failed_tax_id_match" | "verification_failed_tax_id_not_issued" | "verification_missing_executives" | "verification_missing_owners" | "verification_requires_additional_memorandum_of_associations"; + code: "invalid_address_city_state_postal_code" | "invalid_dob_age_under_18" | "invalid_representative_country" | "invalid_street_address" | "invalid_tos_acceptance" | "invalid_value_other" | "verification_directors_mismatch" | "verification_document_address_mismatch" | "verification_document_address_missing" | "verification_document_corrupt" | "verification_document_country_not_supported" | "verification_document_directors_mismatch" | "verification_document_dob_mismatch" | "verification_document_duplicate_type" | "verification_document_expired" | "verification_document_failed_copy" | "verification_document_failed_greyscale" | "verification_document_failed_other" | "verification_document_failed_test_mode" | "verification_document_fraudulent" | "verification_document_id_number_mismatch" | "verification_document_id_number_missing" | "verification_document_incomplete" | "verification_document_invalid" | "verification_document_issue_or_expiry_date_missing" | "verification_document_manipulated" | "verification_document_missing_back" | "verification_document_missing_front" | "verification_document_name_mismatch" | "verification_document_name_missing" | "verification_document_nationality_mismatch" | "verification_document_not_readable" | "verification_document_not_signed" | "verification_document_not_uploaded" | "verification_document_photo_mismatch" | "verification_document_too_large" | "verification_document_type_not_supported" | "verification_extraneous_directors" | "verification_failed_address_match" | "verification_failed_business_iec_number" | "verification_failed_document_match" | "verification_failed_id_number_match" | "verification_failed_keyed_identity" | "verification_failed_keyed_match" | "verification_failed_name_match" | "verification_failed_other" | "verification_failed_residential_address" | "verification_failed_tax_id_match" | "verification_failed_tax_id_not_issued" | "verification_missing_directors" | "verification_missing_executives" | "verification_missing_owners" | "verification_requires_additional_memorandum_of_associations"; /** @description An informative message that indicates the error type and provides additional details about the error. */ reason: string; /** @description The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. */ @@ -2635,9 +2635,9 @@ export interface components { application_fee: { /** @description ID of the Stripe account this fee was taken from. */ account: string | components["schemas"]["account"]; - /** @description Amount earned, in %s. */ + /** @description Amount earned, in cents (or local equivalent). */ amount: number; - /** @description Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued) */ + /** @description Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued) */ amount_refunded: number; /** @description ID of the Connect application that earned the fee. */ application: string | components["schemas"]["application"]; @@ -2795,7 +2795,7 @@ export interface components { * Related guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types) */ balance_transaction: { - /** @description Gross amount of the transaction, in %s. */ + /** @description Gross amount of the transaction, in cents (or local equivalent). */ amount: number; /** * Format: unix-time @@ -2813,13 +2813,13 @@ export interface components { description?: string | null; /** @description The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the `amount` in currency A, times `exchange_rate`, would be the `amount` in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and `currency` would be `eur`. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's `amount` would be `1234`, `currency` would be `usd`, and `exchange_rate` would be `1.234`. */ exchange_rate?: number | null; - /** @description Fees (in %s) paid for this transaction. */ + /** @description Fees (in cents (or local equivalent)) paid for this transaction. */ fee: number; - /** @description Detailed breakdown of fees (in %s) paid for this transaction. */ + /** @description Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction. */ fee_details: components["schemas"]["fee"][]; /** @description Unique identifier for the object. */ id: string; - /** @description Net amount of the transaction, in %s. */ + /** @description Net amount of the transaction, in cents (or local equivalent). */ net: number; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -2833,10 +2833,10 @@ export interface components { /** @description If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`. */ status: string; /** - * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. [Learn more](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider `reporting_category` instead. + * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. [Learn more](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider `reporting_category` instead. * @enum {string} */ - type: "adjustment" | "advance" | "advance_funding" | "anticipation_repayment" | "application_fee" | "application_fee_refund" | "charge" | "connect_collection_transfer" | "contribution" | "issuing_authorization_hold" | "issuing_authorization_release" | "issuing_dispute" | "issuing_transaction" | "payment" | "payment_failure_refund" | "payment_refund" | "payout" | "payout_cancel" | "payout_failure" | "refund" | "refund_failure" | "reserve_transaction" | "reserved_funds" | "stripe_fee" | "stripe_fx_fee" | "tax_fee" | "topup" | "topup_reversal" | "transfer" | "transfer_cancel" | "transfer_failure" | "transfer_refund"; + type: "adjustment" | "advance" | "advance_funding" | "anticipation_repayment" | "application_fee" | "application_fee_refund" | "charge" | "connect_collection_transfer" | "contribution" | "issuing_authorization_hold" | "issuing_authorization_release" | "issuing_dispute" | "issuing_transaction" | "payment" | "payment_failure_refund" | "payment_refund" | "payment_reversal" | "payout" | "payout_cancel" | "payout_failure" | "refund" | "refund_failure" | "reserve_transaction" | "reserved_funds" | "stripe_fee" | "stripe_fx_fee" | "tax_fee" | "topup" | "topup_reversal" | "transfer" | "transfer_cancel" | "transfer_failure" | "transfer_refund"; }; /** * BankAccount @@ -3260,9 +3260,9 @@ export interface components { charge: { /** @description Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ amount: number; - /** @description Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made). */ + /** @description Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made). */ amount_captured: number; - /** @description Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued). */ + /** @description Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued). */ amount_refunded: number; /** @description ID of the Connect application that created the charge. */ application?: (string | components["schemas"]["application"]) | null; @@ -4005,7 +4005,7 @@ export interface components { }; /** ConnectCollectionTransfer */ connect_collection_transfer: { - /** @description Amount transferred, in %s. */ + /** @description Amount transferred, in cents (or local equivalent). */ 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; @@ -4109,7 +4109,7 @@ export interface components { * @enum {string} */ object: "coupon"; - /** @description Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a %s100 invoice %s50 instead. */ + /** @description Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead. */ percent_off?: number | null; /** * Format: unix-time @@ -4138,7 +4138,7 @@ export interface components { * Related guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes) */ credit_note: { - /** @description The integer amount in %s representing the total amount of the credit note, including tax. */ + /** @description The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax. */ amount: number; /** @description This is the sum of all the shipping amounts. */ amount_shipping: number; @@ -4153,7 +4153,7 @@ export interface components { customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; /** @description Customer balance transaction related to this credit note. */ customer_balance_transaction?: (string | components["schemas"]["customer_balance_transaction"]) | null; - /** @description The integer amount in %s representing the total amount of discount that was credited. */ + /** @description The integer amount in cents (or local equivalent) representing the total amount of discount that was credited. */ discount_amount: number; /** @description The aggregate amounts calculated per discount for all line items. */ discount_amounts: components["schemas"]["discounts_resource_discount_amount"][]; @@ -4216,15 +4216,15 @@ export interface components { * @enum {string} */ status: "issued" | "void"; - /** @description The integer amount in %s representing the amount of the credit note, excluding exclusive tax and invoice level discounts. */ + /** @description The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts. */ subtotal: number; - /** @description The integer amount in %s representing the amount of the credit note, excluding all tax and invoice level discounts. */ + /** @description The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts. */ subtotal_excluding_tax?: number | null; /** @description The aggregate amounts calculated per tax rate for all line items. */ tax_amounts: components["schemas"]["credit_note_tax_amount"][]; - /** @description The integer amount in %s representing the total amount of the credit note, including tax and all discount. */ + /** @description The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount. */ total: number; - /** @description The integer amount in %s representing the total amount of the credit note, excluding tax, but including discounts. */ + /** @description The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts. */ total_excluding_tax?: number | null; /** * @description Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid. @@ -4237,15 +4237,18 @@ export interface components { */ voided_at?: number | null; }; - /** CreditNoteLineItem */ + /** + * CreditNoteLineItem + * @description The credit note line item object + */ credit_note_line_item: { - /** @description The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. */ + /** @description The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. */ amount: number; - /** @description The integer amount in %s representing the amount being credited for this line item, excluding all tax and discounts. */ + /** @description The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts. */ amount_excluding_tax?: number | null; /** @description Description of the item being credited. */ description?: string | null; - /** @description The integer amount in %s representing the discount being credited for this line item. */ + /** @description The integer amount in cents (or local equivalent) representing the discount being credited for this line item. */ discount_amount: number; /** @description The amount of discount calculated per discount for this line item */ discount_amounts: components["schemas"]["discounts_resource_discount_amount"][]; @@ -4280,13 +4283,13 @@ export interface components { unit_amount_decimal?: string | null; /** * Format: decimal - * @description The amount in %s representing the unit amount being credited for this line item, excluding all tax and discounts. + * @description The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts. */ unit_amount_excluding_tax?: string | null; }; /** CreditNoteTaxAmount */ credit_note_tax_amount: { - /** @description The amount, in %s, of the tax. */ + /** @description The amount, in cents (or local equivalent), of the tax. */ amount: number; /** @description Whether this tax amount is inclusive or exclusive. */ inclusive: boolean; @@ -4297,7 +4300,7 @@ export interface components { * @enum {string|null} */ taxability_reason?: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated" | null; - /** @description The amount on which tax is calculated, in %s. */ + /** @description The amount on which tax is calculated, in cents (or local equivalent). */ taxable_amount?: number | null; }; /** CurrencyOption */ @@ -4311,11 +4314,11 @@ export interface components { tax_behavior?: "exclusive" | "inclusive" | "unspecified" | null; /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: components["schemas"]["price_tier"][]; - /** @description The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ + /** @description The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ unit_amount?: number | null; /** * Format: decimal - * @description The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. + * @description The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ unit_amount_decimal?: string | null; }; @@ -4481,6 +4484,13 @@ export interface components { /** @description A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance */ using_merchant_default: boolean; }; + /** CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft */ + customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft: { + /** @description The [Balance Transaction](docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance. */ + balance_transaction: string | components["schemas"]["balance_transaction"]; + /** @description The [Cash Balance Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds. */ + linked_transaction: string | components["schemas"]["customer_cash_balance_transaction"]; + }; /** CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction */ customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction: { /** @description The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were applied to. */ @@ -4607,6 +4617,7 @@ export interface components { * to payments, and refunds to the customer. */ customer_cash_balance_transaction: { + adjusted_for_overdraft?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft"]; applied_to_payment?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction"]; /** * Format: unix-time @@ -4636,7 +4647,7 @@ export interface components { * @description The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://stripe.com/docs/payments/customer-balance#types) to learn more about these types. * @enum {string} */ - type: "applied_to_payment" | "funded" | "funding_reversed" | "refunded_from_payment" | "return_canceled" | "return_initiated" | "unapplied_from_payment"; + type: "adjusted_for_overdraft" | "applied_to_payment" | "funded" | "funding_reversed" | "refunded_from_payment" | "return_canceled" | "return_initiated" | "unapplied_from_payment"; unapplied_from_payment?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction"]; }; /** CustomerTax */ @@ -5077,7 +5088,7 @@ export interface components { }; /** DiscountsResourceDiscountAmount */ discounts_resource_discount_amount: { - /** @description The amount, in %s, of the discount. */ + /** @description The amount, in cents (or local equivalent), of the discount. */ amount: number; /** @description The discount that was applied to get this discount amount. */ discount: string | components["schemas"]["discount"] | components["schemas"]["deleted_discount"]; @@ -5125,13 +5136,14 @@ export interface components { object: "dispute"; /** @description ID of the PaymentIntent that was disputed. */ payment_intent?: (string | components["schemas"]["payment_intent"]) | null; + payment_method_details?: components["schemas"]["dispute_payment_method_details"]; /** @description Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories). */ reason: string; /** - * @description Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `charge_refunded`, `won`, or `lost`. + * @description Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, or `lost`. * @enum {string} */ - status: "charge_refunded" | "lost" | "needs_response" | "under_review" | "warning_closed" | "warning_needs_response" | "warning_under_review" | "won"; + status: "lost" | "needs_response" | "under_review" | "warning_closed" | "warning_needs_response" | "warning_under_review" | "won"; }; /** DisputeEvidence */ dispute_evidence: { @@ -5204,6 +5216,23 @@ export interface components { /** @description The number of times evidence has been submitted. Typically, you may only submit evidence once. */ submission_count: number; }; + /** DisputePaymentMethodDetails */ + dispute_payment_method_details: { + /** @description Card specific dispute details. */ + card?: components["schemas"]["dispute_payment_method_details_card"] | null; + /** + * @description Payment method type. + * @enum {string} + */ + type: "card"; + }; + /** DisputePaymentMethodDetailsCard */ + dispute_payment_method_details_card: { + /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + brand: string; + /** @description The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network. */ + network_reason_code?: string | null; + }; /** EmailSent */ email_sent: { /** @@ -5363,7 +5392,7 @@ export interface components { * Related guide: [Refunding application fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee) */ fee_refund: { - /** @description Amount, in %s. */ + /** @description Amount, in cents (or local equivalent). */ amount: number; /** @description Balance transaction that describes the impact on your account balance. */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; @@ -6210,15 +6239,15 @@ export interface components { account_tax_ids?: ((string | components["schemas"]["tax_id"] | components["schemas"]["deleted_tax_id"])[]) | null; /** @description Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`. */ amount_due: number; - /** @description The amount, in %s, that was paid. */ + /** @description The amount, in cents (or local equivalent), that was paid. */ amount_paid: number; - /** @description The difference between amount_due and amount_paid, in %s. */ + /** @description The difference between amount_due and amount_paid, in cents (or local equivalent). */ amount_remaining: number; /** @description This is the sum of all the shipping amounts. */ amount_shipping: number; /** @description ID of the Connect Application that created the invoice. */ application?: (string | components["schemas"]["application"] | components["schemas"]["deleted_application"]) | null; - /** @description The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. */ + /** @description The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. */ application_fee_amount?: number | null; /** @description Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. */ attempt_count: number; @@ -6391,7 +6420,7 @@ export interface components { subscription_proration_date?: number; /** @description Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated */ subtotal: number; - /** @description The integer amount in %s representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated */ + /** @description The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated */ subtotal_excluding_tax?: number | null; /** @description The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. */ tax?: number | null; @@ -6402,7 +6431,7 @@ export interface components { total: number; /** @description The aggregate amounts calculated per discount across all line items. */ total_discount_amounts?: components["schemas"]["discounts_resource_discount_amount"][] | null; - /** @description The integer amount in %s representing the total amount of the invoice including all discounts but excluding all tax. */ + /** @description The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax. */ total_excluding_tax?: number | null; /** @description The aggregate amounts calculated per tax rate for all line items. */ total_tax_amounts: components["schemas"]["invoice_tax_amount"][]; @@ -6564,7 +6593,7 @@ export interface components { }; /** InvoiceTaxAmount */ invoice_tax_amount: { - /** @description The amount, in %s, of the tax. */ + /** @description The amount, in cents (or local equivalent), of the tax. */ amount: number; /** @description Whether this tax amount is inclusive or exclusive. */ inclusive: boolean; @@ -6575,7 +6604,7 @@ export interface components { * @enum {string|null} */ taxability_reason?: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated" | null; - /** @description The amount on which tax is calculated, in %s. */ + /** @description The amount on which tax is calculated, in cents (or local equivalent). */ taxable_amount?: number | null; }; /** InvoiceThresholdReason */ @@ -6587,7 +6616,7 @@ export interface components { }; /** InvoiceTransferData */ invoice_transfer_data: { - /** @description The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ + /** @description The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ amount?: number | null; /** @description The account where funds from the payment will be transferred to upon payment success. */ destination: string | components["schemas"]["account"]; @@ -7703,7 +7732,7 @@ export interface components { * @description The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. * @enum {string} */ - structure?: "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit"; + structure?: "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "incorporated_partnership" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit" | "unincorporated_partnership"; /** @description Whether the company's business ID number was provided. */ tax_id_provided?: boolean; /** @description The jurisdiction in which the `tax_id` is registered (Germany-based companies only). */ @@ -7791,9 +7820,9 @@ export interface components { }; /** InvoiceLineItem */ line_item: { - /** @description The amount, in %s. */ + /** @description The amount, in cents (or local equivalent). */ amount: number; - /** @description The integer amount in %s representing the amount for this line item, excluding all tax and discounts. */ + /** @description The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts. */ amount_excluding_tax?: number | null; /** @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; @@ -7844,7 +7873,7 @@ export interface components { type: "invoiceitem" | "subscription"; /** * Format: decimal - * @description The amount in %s representing the unit amount for this line item, excluding all tax and discounts. + * @description The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts. */ unit_amount_excluding_tax?: string | null; }; @@ -7864,7 +7893,7 @@ export interface components { * @enum {string|null} */ taxability_reason?: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated" | null; - /** @description The amount on which tax is calculated, in %s. */ + /** @description The amount on which tax is calculated, in cents (or local equivalent). */ taxable_amount?: number | null; }; /** linked_account_options_us_bank_account */ @@ -7959,46 +7988,17 @@ export interface components { /** @description The URL that will contain the mandate that the customer has signed. */ url: string; }; - /** mandate_blik */ - mandate_blik: { - /** - * Format: unix-time - * @description Date at which the mandate expires. - */ - expires_after?: number | null; - off_session?: components["schemas"]["mandate_options_off_session_details_blik"]; - /** - * @description Type of the mandate. - * @enum {string|null} - */ - type?: "off_session" | "on_session" | null; - }; /** mandate_cashapp */ mandate_cashapp: Record; /** mandate_link */ mandate_link: Record; /** mandate_multi_use */ mandate_multi_use: Record; - /** mandate_options_off_session_details_blik */ - mandate_options_off_session_details_blik: { - /** @description Amount of each recurring payment. */ - amount?: number | null; - /** @description Currency of each recurring payment. */ - currency?: string | null; - /** - * @description Frequency interval of each recurring payment. - * @enum {string|null} - */ - interval?: "day" | "month" | "week" | "year" | null; - /** @description Frequency indicator of each recurring payment. */ - interval_count?: number | null; - }; /** mandate_payment_method_details */ mandate_payment_method_details: { acss_debit?: components["schemas"]["mandate_acss_debit"]; au_becs_debit?: components["schemas"]["mandate_au_becs_debit"]; bacs_debit?: components["schemas"]["mandate_bacs_debit"]; - blik?: components["schemas"]["mandate_blik"]; card?: components["schemas"]["card_mandate_payment_method_details"]; cashapp?: components["schemas"]["mandate_cashapp"]; link?: components["schemas"]["mandate_link"]; @@ -8663,9 +8663,7 @@ export interface components { setup_future_usage?: "none" | "off_session" | "on_session"; }; /** payment_intent_payment_method_options_blik */ - payment_intent_payment_method_options_blik: { - mandate_options?: components["schemas"]["payment_intent_payment_method_options_mandate_options_blik"]; - }; + payment_intent_payment_method_options_blik: Record; /** payment_intent_payment_method_options_card */ payment_intent_payment_method_options_card: { /** @@ -8751,20 +8749,6 @@ export interface components { */ transaction_type?: "business" | "personal" | null; }; - /** payment_intent_payment_method_options_mandate_options_blik */ - payment_intent_payment_method_options_mandate_options_blik: { - /** - * Format: unix-time - * @description Date at which the mandate expires. - */ - expires_after?: number | null; - off_session?: components["schemas"]["mandate_options_off_session_details_blik"]; - /** - * @description Type of the mandate. - * @enum {string|null} - */ - type?: "off_session" | "on_session" | null; - }; /** payment_intent_payment_method_options_mandate_options_sepa_debit */ payment_intent_payment_method_options_mandate_options_sepa_debit: Record; /** payment_intent_payment_method_options_sepa_debit */ @@ -8783,6 +8767,11 @@ export interface components { /** payment_intent_payment_method_options_us_bank_account */ payment_intent_payment_method_options_us_bank_account: { financial_connections?: components["schemas"]["linked_account_options_us_bank_account"]; + /** + * @description Preferred transaction settlement speed + * @enum {string} + */ + preferred_settlement_speed?: "fastest" | "standard"; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -9110,7 +9099,7 @@ export interface components { }; /** PaymentLinksResourceTransferData */ payment_links_resource_transfer_data: { - /** @description The amount in %s that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ + /** @description The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ amount?: number | null; /** @description The connected account receiving the transfer. */ destination: string | components["schemas"]["account"]; @@ -9563,7 +9552,7 @@ export interface components { /** @description If this card has network token credentials, this contains the details of the network token credentials. */ network_token?: components["schemas"]["payment_method_details_card_network_token"] | null; /** @description Populated if this transaction used 3D Secure authentication. */ - three_d_secure?: components["schemas"]["three_d_secure_details"] | null; + three_d_secure?: components["schemas"]["three_d_secure_details_charge"] | null; /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ wallet?: components["schemas"]["payment_method_details_card_wallet"] | null; }; @@ -10907,7 +10896,7 @@ export interface components { * Related guide: [Receiving payouts](https://stripe.com/docs/payouts) */ payout: { - /** @description Amount (in %s) to be transferred to your bank account or debit card. */ + /** @description Amount (in cents (or local equivalent)) to be transferred to your bank account or debit card. */ amount: number; /** * Format: unix-time @@ -11131,11 +11120,11 @@ export interface components { * @enum {string|null} */ aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum" | null; - /** @description The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ + /** @description The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ amount?: number | null; /** * Format: decimal - * @description The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. + * @description The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ amount_decimal?: string | null; /** @@ -11463,11 +11452,11 @@ export interface components { * @enum {string} */ type: "one_time" | "recurring"; - /** @description The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ + /** @description The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ unit_amount?: number | null; /** * Format: decimal - * @description The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. + * @description The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ unit_amount_decimal?: string | null; }; @@ -11799,7 +11788,7 @@ export interface components { }; /** QuotesResourceTransferData */ quotes_resource_transfer_data: { - /** @description The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ + /** @description The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ amount?: number | null; /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination. */ amount_percent?: number | null; @@ -12015,7 +12004,7 @@ export interface components { * Related guide: [Refunds](https://stripe.com/docs/refunds) */ refund: { - /** @description Amount, in %s. */ + /** @description Amount, in cents (or local equivalent). */ amount: number; /** @description Balance transaction that describes the impact on your account balance. */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; @@ -12370,7 +12359,6 @@ export interface components { au_becs_debit?: components["schemas"]["setup_attempt_payment_method_details_au_becs_debit"]; bacs_debit?: components["schemas"]["setup_attempt_payment_method_details_bacs_debit"]; bancontact?: components["schemas"]["setup_attempt_payment_method_details_bancontact"]; - blik?: components["schemas"]["setup_attempt_payment_method_details_blik"]; boleto?: components["schemas"]["setup_attempt_payment_method_details_boleto"]; card?: components["schemas"]["setup_attempt_payment_method_details_card"]; card_present?: components["schemas"]["setup_attempt_payment_method_details_card_present"]; @@ -12417,8 +12405,6 @@ export interface components { */ verified_name?: string | null; }; - /** setup_attempt_payment_method_details_blik */ - setup_attempt_payment_method_details_blik: Record; /** setup_attempt_payment_method_details_boleto */ setup_attempt_payment_method_details_boleto: Record; /** setup_attempt_payment_method_details_card */ @@ -12561,7 +12547,7 @@ export interface components { * It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer. */ attach_to_self?: boolean; - /** @description Settings for automatic payment methods compatible with this Setup Intent */ + /** @description Settings for dynamic payment methods compatible with this Setup Intent */ automatic_payment_methods?: components["schemas"]["payment_flows_automatic_payment_methods_setup_intent"] | null; /** * @description Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`. @@ -12671,7 +12657,6 @@ export interface components { /** SetupIntentPaymentMethodOptions */ setup_intent_payment_method_options: { acss_debit?: components["schemas"]["setup_intent_payment_method_options_acss_debit"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; - blik?: components["schemas"]["setup_intent_payment_method_options_blik"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; card?: components["schemas"]["setup_intent_payment_method_options_card"]; link?: components["schemas"]["setup_intent_payment_method_options_link"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; paypal?: components["schemas"]["setup_intent_payment_method_options_paypal"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; @@ -12692,10 +12677,6 @@ export interface components { */ verification_method?: "automatic" | "instant" | "microdeposits"; }; - /** setup_intent_payment_method_options_blik */ - setup_intent_payment_method_options_blik: { - mandate_options?: components["schemas"]["setup_intent_payment_method_options_mandate_options_blik"]; - }; /** setup_intent_payment_method_options_card */ setup_intent_payment_method_options_card: { /** @description Configuration options for setting up an eMandate for cards issued in India. */ @@ -12767,20 +12748,6 @@ export interface components { */ transaction_type?: "business" | "personal" | null; }; - /** setup_intent_payment_method_options_mandate_options_blik */ - setup_intent_payment_method_options_mandate_options_blik: { - /** - * Format: unix-time - * @description Date at which the mandate expires. - */ - expires_after?: number | null; - off_session?: components["schemas"]["mandate_options_off_session_details_blik"]; - /** - * @description Type of the mandate. - * @enum {string|null} - */ - type?: "off_session" | "on_session" | null; - }; /** setup_intent_payment_method_options_mandate_options_sepa_debit */ setup_intent_payment_method_options_mandate_options_sepa_debit: Record; /** setup_intent_payment_method_options_paypal */ @@ -14459,7 +14426,11 @@ export interface components { description?: string | null; /** @description The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page. */ display_name: string; - /** @description Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage does not include the statutory tax rate of non-taxable jurisdictions. */ + /** + * @description Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, + * this percentage reflects the rate actually used to calculate tax based on the product's taxability + * and whether the user is registered to collect taxes in the corresponding jurisdiction. + */ effective_percentage?: number | null; /** @description Unique identifier for the object. */ id: string; @@ -14666,6 +14637,11 @@ export interface components { payment_intent: string | components["schemas"]["payment_intent"]; process_config?: components["schemas"]["terminal_reader_reader_resource_process_config"]; }; + /** + * TerminalReaderReaderResourceProcessSetupConfig + * @description Represents a per-setup override of a reader configuration + */ + terminal_reader_reader_resource_process_setup_config: Record; /** * TerminalReaderReaderResourceProcessSetupIntentAction * @description Represents a reader action to process a setup intent @@ -14673,6 +14649,7 @@ export interface components { terminal_reader_reader_resource_process_setup_intent_action: { /** @description ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. */ generated_card?: string; + process_config?: components["schemas"]["terminal_reader_reader_resource_process_setup_config"]; /** @description Most recent SetupIntent processed by the reader. */ setup_intent: string | components["schemas"]["setup_intent"]; }; @@ -14812,6 +14789,31 @@ export interface components { */ version?: "1.0.2" | "2.1.0" | "2.2.0" | null; }; + /** three_d_secure_details_charge */ + three_d_secure_details_charge: { + /** + * @description For authenticated transactions: how the customer was authenticated by + * the issuing bank. + * @enum {string|null} + */ + authentication_flow?: "challenge" | "frictionless" | null; + /** + * @description Indicates the outcome of 3D Secure authentication. + * @enum {string|null} + */ + result?: "attempt_acknowledged" | "authenticated" | "exempted" | "failed" | "not_supported" | "processing_error" | null; + /** + * @description Additional information about why 3D Secure succeeded or failed based + * on the `result`. + * @enum {string|null} + */ + result_reason?: "abandoned" | "bypassed" | "canceled" | "card_not_enrolled" | "network_not_supported" | "protocol_error" | "rejected" | null; + /** + * @description The version of 3D Secure that was used. + * @enum {string|null} + */ + version?: "1.0.2" | "2.1.0" | "2.2.0" | null; + }; /** three_d_secure_usage */ three_d_secure_usage: { /** @description Whether 3D Secure is supported on this card. */ @@ -14931,9 +14933,9 @@ export interface components { * Related guide: [Creating separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) */ transfer: { - /** @description Amount in %s to be transferred. */ + /** @description Amount in cents (or local equivalent) to be transferred. */ amount: number; - /** @description Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). */ + /** @description Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). */ amount_reversed: number; /** @description Balance transaction that describes the impact of this transfer on your account balance. */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; @@ -15017,7 +15019,7 @@ export interface components { * Related guide: [Reversing transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reversing-transfers) */ transfer_reversal: { - /** @description Amount, in %s. */ + /** @description Amount, in cents (or local equivalent). */ amount: number; /** @description Balance transaction that describes the impact on your account balance. */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; @@ -16564,7 +16566,7 @@ export interface operations { phone?: string; registration_number?: string; /** @enum {string} */ - structure?: "" | "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit"; + structure?: "" | "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "incorporated_partnership" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit" | "unincorporated_partnership"; tax_id?: string; tax_id_registrar?: string; vat_id?: string; @@ -16844,7 +16846,7 @@ export interface operations { * for a Standard or Express account, some parameters can no longer be changed. These are marked as Custom Only or Custom and Express * below.

* - *

To update your own account, use the Dashboard. Refer to our + *

To update your own account, use the Dashboard. Refer to our * Connect documentation to learn more about updating accounts.

*/ PostAccountsAccount: { @@ -17092,7 +17094,7 @@ export interface operations { phone?: string; registration_number?: string; /** @enum {string} */ - structure?: "" | "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit"; + structure?: "" | "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "incorporated_partnership" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit" | "unincorporated_partnership"; tax_id?: string; tax_id_registrar?: string; vat_id?: string; @@ -17330,7 +17332,7 @@ export interface operations { * *

Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.

* - *

If you want to delete your own account, use the account information tab in your account settings instead.

+ *

If you want to delete your own account, use the account information tab in your account settings instead.

*/ DeleteAccountsAccount: { parameters: { @@ -19532,7 +19534,7 @@ export interface operations { source?: string; /** @description A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ starting_after?: string; - /** @description Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ + /** @description Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ type?: string; }; }; @@ -19630,7 +19632,7 @@ export interface operations { source?: string; /** @description A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ starting_after?: string; - /** @description Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ + /** @description Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ type?: string; }; }; @@ -20029,7 +20031,7 @@ export interface operations { type: "payment_method_update" | "subscription_cancel" | "subscription_update" | "subscription_update_confirm"; }; /** - * @description The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used. + * @description The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used. * @enum {string} */ locale?: "auto" | "bg" | "cs" | "da" | "de" | "el" | "en" | "en-AU" | "en-CA" | "en-GB" | "en-IE" | "en-IN" | "en-NZ" | "en-SG" | "es" | "es-419" | "et" | "fi" | "fil" | "fr" | "fr-CA" | "hr" | "hu" | "id" | "it" | "ja" | "ko" | "lt" | "lv" | "ms" | "mt" | "nb" | "nl" | "pl" | "pt" | "pt-BR" | "ro" | "ru" | "sk" | "sl" | "sv" | "th" | "tr" | "vi" | "zh" | "zh-HK" | "zh-TW"; @@ -27067,7 +27069,7 @@ export interface operations { /** Format: decimal */ unit_amount_decimal?: string; })[]; - /** @description The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ + /** @description The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ schedule?: string; /** @description The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ subscription?: string; @@ -27247,7 +27249,7 @@ export interface operations { })[]; /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ limit?: number; - /** @description The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ + /** @description The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ schedule?: string; /** @description A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ starting_after?: string; @@ -29823,19 +29825,9 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; }) | ""; - blik?: ({ + blik?: { code?: string; - /** payment_intent_payment_method_options_mandate_options_param */ - mandate_options?: { - expires_after?: number; - /** mandate_options_off_session_details_common_param */ - off_session?: { - /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count: number; - }; - }; - }) | ""; + } | ""; boleto?: ({ expires_after_days?: number; /** @enum {string} */ @@ -30008,6 +30000,8 @@ export interface operations { requested?: ("ach" | "us_domestic_wire")[]; }; /** @enum {string} */ + preferred_settlement_speed?: "" | "fastest" | "standard"; + /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; @@ -30426,19 +30420,9 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; }) | ""; - blik?: ({ + blik?: { code?: string; - /** payment_intent_payment_method_options_mandate_options_param */ - mandate_options?: { - expires_after?: number; - /** mandate_options_off_session_details_common_param */ - off_session?: { - /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count: number; - }; - }; - }) | ""; + } | ""; boleto?: ({ expires_after_days?: number; /** @enum {string} */ @@ -30611,6 +30595,8 @@ export interface operations { requested?: ("ach" | "us_domestic_wire")[]; }; /** @enum {string} */ + preferred_settlement_speed?: "" | "fastest" | "standard"; + /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; @@ -31096,19 +31082,9 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; }) | ""; - blik?: ({ + blik?: { code?: string; - /** payment_intent_payment_method_options_mandate_options_param */ - mandate_options?: { - expires_after?: number; - /** mandate_options_off_session_details_common_param */ - off_session?: { - /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count: number; - }; - }; - }) | ""; + } | ""; boleto?: ({ expires_after_days?: number; /** @enum {string} */ @@ -31281,6 +31257,8 @@ export interface operations { requested?: ("ach" | "us_domestic_wire")[]; }; /** @enum {string} */ + preferred_settlement_speed?: "" | "fastest" | "standard"; + /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; @@ -31917,7 +31895,7 @@ export interface operations { * @enum {string} */ payment_method_collection?: "always" | "if_required"; - /** @description The list of payment method types that customers can use. Pass an empty string to enable automatic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ + /** @description The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ payment_method_types?: (("affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[]) | ""; /** @description Configuration for collecting the customer's shipping address. */ shipping_address_collection?: ({ @@ -35737,23 +35715,6 @@ export interface operations { /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; }; - /** setup_intent_payment_method_options_param */ - blik?: { - code?: string; - /** setup_intent_payment_method_options_mandate_options_param */ - mandate_options?: { - expires_after?: number; - /** mandate_options_off_session_details_param */ - off_session?: { - amount: number; - /** @enum {string} */ - currency: "pln"; - /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count: number; - }; - }; - }; /** setup_intent_param */ card?: { /** setup_intent_mandate_options_param */ @@ -36076,23 +36037,6 @@ export interface operations { /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; }; - /** setup_intent_payment_method_options_param */ - blik?: { - code?: string; - /** setup_intent_payment_method_options_mandate_options_param */ - mandate_options?: { - expires_after?: number; - /** mandate_options_off_session_details_param */ - off_session?: { - amount: number; - /** @enum {string} */ - currency: "pln"; - /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count: number; - }; - }; - }; /** setup_intent_param */ card?: { /** setup_intent_mandate_options_param */ @@ -36419,23 +36363,6 @@ export interface operations { /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; }; - /** setup_intent_payment_method_options_param */ - blik?: { - code?: string; - /** setup_intent_payment_method_options_mandate_options_param */ - mandate_options?: { - expires_after?: number; - /** mandate_options_off_session_details_param */ - off_session?: { - amount: number; - /** @enum {string} */ - currency: "pln"; - /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count: number; - }; - }; - }; /** setup_intent_param */ card?: { /** setup_intent_mandate_options_param */ @@ -39175,6 +39102,8 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** @description A flat amount to reverse across the entire transaction, in negative integer cents. This value represents the total amount to refund from the transaction, including taxes. */ + flat_amount?: number; /** @description The line item amounts to reverse. */ line_items?: { amount: number; @@ -40421,6 +40350,11 @@ export interface operations { customer_consent_collected: boolean; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** + * process_setup_config + * @description Configuration overrides + */ + process_config?: Record; /** @description SetupIntent ID */ setup_intent: string; }; @@ -41404,7 +41338,7 @@ export interface operations { phone?: string; registration_number?: string; /** @enum {string} */ - structure?: "" | "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit"; + structure?: "" | "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "incorporated_partnership" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit" | "unincorporated_partnership"; tax_id?: string; tax_id_registrar?: string; vat_id?: string; @@ -43809,7 +43743,7 @@ export interface operations { * @description Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version. * @enum {string} */ - api_version?: "2011-01-01" | "2011-06-21" | "2011-06-28" | "2011-08-01" | "2011-09-15" | "2011-11-17" | "2012-02-23" | "2012-03-25" | "2012-06-18" | "2012-06-28" | "2012-07-09" | "2012-09-24" | "2012-10-26" | "2012-11-07" | "2013-02-11" | "2013-02-13" | "2013-07-05" | "2013-08-12" | "2013-08-13" | "2013-10-29" | "2013-12-03" | "2014-01-31" | "2014-03-13" | "2014-03-28" | "2014-05-19" | "2014-06-13" | "2014-06-17" | "2014-07-22" | "2014-07-26" | "2014-08-04" | "2014-08-20" | "2014-09-08" | "2014-10-07" | "2014-11-05" | "2014-11-20" | "2014-12-08" | "2014-12-17" | "2014-12-22" | "2015-01-11" | "2015-01-26" | "2015-02-10" | "2015-02-16" | "2015-02-18" | "2015-03-24" | "2015-04-07" | "2015-06-15" | "2015-07-07" | "2015-07-13" | "2015-07-28" | "2015-08-07" | "2015-08-19" | "2015-09-03" | "2015-09-08" | "2015-09-23" | "2015-10-01" | "2015-10-12" | "2015-10-16" | "2016-02-03" | "2016-02-19" | "2016-02-22" | "2016-02-23" | "2016-02-29" | "2016-03-07" | "2016-06-15" | "2016-07-06" | "2016-10-19" | "2017-01-27" | "2017-02-14" | "2017-04-06" | "2017-05-25" | "2017-06-05" | "2017-08-15" | "2017-12-14" | "2018-01-23" | "2018-02-05" | "2018-02-06" | "2018-02-28" | "2018-05-21" | "2018-07-27" | "2018-08-23" | "2018-09-06" | "2018-09-24" | "2018-10-31" | "2018-11-08" | "2019-02-11" | "2019-02-19" | "2019-03-14" | "2019-05-16" | "2019-08-14" | "2019-09-09" | "2019-10-08" | "2019-10-17" | "2019-11-05" | "2019-12-03" | "2020-03-02" | "2020-08-27" | "2022-08-01" | "2022-11-15"; + api_version?: "2011-01-01" | "2011-06-21" | "2011-06-28" | "2011-08-01" | "2011-09-15" | "2011-11-17" | "2012-02-23" | "2012-03-25" | "2012-06-18" | "2012-06-28" | "2012-07-09" | "2012-09-24" | "2012-10-26" | "2012-11-07" | "2013-02-11" | "2013-02-13" | "2013-07-05" | "2013-08-12" | "2013-08-13" | "2013-10-29" | "2013-12-03" | "2014-01-31" | "2014-03-13" | "2014-03-28" | "2014-05-19" | "2014-06-13" | "2014-06-17" | "2014-07-22" | "2014-07-26" | "2014-08-04" | "2014-08-20" | "2014-09-08" | "2014-10-07" | "2014-11-05" | "2014-11-20" | "2014-12-08" | "2014-12-17" | "2014-12-22" | "2015-01-11" | "2015-01-26" | "2015-02-10" | "2015-02-16" | "2015-02-18" | "2015-03-24" | "2015-04-07" | "2015-06-15" | "2015-07-07" | "2015-07-13" | "2015-07-28" | "2015-08-07" | "2015-08-19" | "2015-09-03" | "2015-09-08" | "2015-09-23" | "2015-10-01" | "2015-10-12" | "2015-10-16" | "2016-02-03" | "2016-02-19" | "2016-02-22" | "2016-02-23" | "2016-02-29" | "2016-03-07" | "2016-06-15" | "2016-07-06" | "2016-10-19" | "2017-01-27" | "2017-02-14" | "2017-04-06" | "2017-05-25" | "2017-06-05" | "2017-08-15" | "2017-12-14" | "2018-01-23" | "2018-02-05" | "2018-02-06" | "2018-02-28" | "2018-05-21" | "2018-07-27" | "2018-08-23" | "2018-09-06" | "2018-09-24" | "2018-10-31" | "2018-11-08" | "2019-02-11" | "2019-02-19" | "2019-03-14" | "2019-05-16" | "2019-08-14" | "2019-09-09" | "2019-10-08" | "2019-10-17" | "2019-11-05" | "2019-12-03" | "2020-03-02" | "2020-08-27" | "2022-08-01" | "2022-11-15" | "2023-08-16"; /** @description Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`. */ connect?: boolean; /** @description An optional description of what the webhook is used for. */ diff --git a/packages/openapi-typescript/examples/stripe-api.yaml b/packages/openapi-typescript/examples/stripe-api.yaml index 6ea0d1b32..116812562 100644 --- a/packages/openapi-typescript/examples/stripe-api.yaml +++ b/packages/openapi-typescript/examples/stripe-api.yaml @@ -1253,10 +1253,12 @@ components: - invalid_street_address - invalid_tos_acceptance - invalid_value_other + - verification_directors_mismatch - verification_document_address_mismatch - verification_document_address_missing - verification_document_corrupt - verification_document_country_not_supported + - verification_document_directors_mismatch - verification_document_dob_mismatch - verification_document_duplicate_type - verification_document_expired @@ -1282,6 +1284,7 @@ components: - verification_document_photo_mismatch - verification_document_too_large - verification_document_type_not_supported + - verification_extraneous_directors - verification_failed_address_match - verification_failed_business_iec_number - verification_failed_document_match @@ -1293,6 +1296,7 @@ components: - verification_failed_residential_address - verification_failed_tax_id_match - verification_failed_tax_id_not_issued + - verification_missing_directors - verification_missing_executives - verification_missing_owners - verification_requires_additional_memorandum_of_associations @@ -1654,12 +1658,12 @@ components: oneOf: - $ref: '#/components/schemas/account' amount: - description: 'Amount earned, in %s.' + description: 'Amount earned, in cents (or local equivalent).' type: integer amount_refunded: description: >- - Amount in %s refunded (can be less than the amount attribute on the - fee if a partial refund was issued) + Amount in cents (or local equivalent) refunded (can be less than the + amount attribute on the fee if a partial refund was issued) type: integer application: anyOf: @@ -2046,7 +2050,7 @@ components: types](https://stripe.com/docs/reports/balance-transaction-types) properties: amount: - description: 'Gross amount of the transaction, in %s.' + description: 'Gross amount of the transaction, in cents (or local equivalent).' type: integer available_on: description: >- @@ -2088,10 +2092,12 @@ components: nullable: true type: number fee: - description: Fees (in %s) paid for this transaction. + description: Fees (in cents (or local equivalent)) paid for this transaction. type: integer fee_details: - description: Detailed breakdown of fees (in %s) paid for this transaction. + description: >- + Detailed breakdown of fees (in cents (or local equivalent)) paid for + this transaction. items: $ref: '#/components/schemas/fee' type: array @@ -2100,7 +2106,7 @@ components: maxLength: 5000 type: string net: - description: 'Net amount of the transaction, in %s.' + description: 'Net amount of the transaction, in cents (or local equivalent).' type: integer object: description: >- @@ -2171,11 +2177,11 @@ components: `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, - `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, - `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, - `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, - `transfer`, `transfer_cancel`, `transfer_failure`, or - `transfer_refund`. [Learn + `payment_refund`, `payment_reversal`, `payout`, `payout_cancel`, + `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, + `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, + `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, + or `transfer_refund`. [Learn more](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might @@ -2197,6 +2203,7 @@ components: - payment - payment_failure_refund - payment_refund + - payment_reversal - payout - payout_cancel - payout_failure @@ -3363,13 +3370,13 @@ components: type: integer amount_captured: description: >- - Amount in %s captured (can be less than the amount attribute on the - charge if a partial capture was made). + Amount in cents (or local equivalent) captured (can be less than the + amount attribute on the charge if a partial capture was made). type: integer amount_refunded: description: >- - Amount in %s refunded (can be less than the amount attribute on the - charge if a partial refund was issued). + Amount in cents (or local equivalent) refunded (can be less than the + amount attribute on the charge if a partial refund was issued). type: integer application: anyOf: @@ -5420,7 +5427,7 @@ components: description: '' properties: amount: - description: 'Amount transferred, in %s.' + description: 'Amount transferred, in cents (or local equivalent).' type: integer currency: description: >- @@ -5690,7 +5697,8 @@ components: description: >- Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with - percent_off of 50 will make a %s100 invoice %s50 instead. + percent_off of 50 will make a $ (or local equivalent)100 invoice $ + (or local equivalent)50 instead. nullable: true type: number redeem_by: @@ -5758,8 +5766,8 @@ components: properties: amount: description: >- - The integer amount in %s representing the total amount of the credit - note, including tax. + The integer amount in cents (or local equivalent) representing the + total amount of the credit note, including tax. type: integer amount_shipping: description: This is the sum of all the shipping amounts. @@ -5800,8 +5808,8 @@ components: - $ref: '#/components/schemas/customer_balance_transaction' discount_amount: description: >- - The integer amount in %s representing the total amount of discount - that was credited. + The integer amount in cents (or local equivalent) representing the + total amount of discount that was credited. type: integer discount_amounts: description: The aggregate amounts calculated per discount for all line items. @@ -5942,13 +5950,15 @@ components: type: string subtotal: description: >- - The integer amount in %s representing the amount of the credit note, - excluding exclusive tax and invoice level discounts. + The integer amount in cents (or local equivalent) representing the + amount of the credit note, excluding exclusive tax and invoice level + discounts. type: integer subtotal_excluding_tax: description: >- - The integer amount in %s representing the amount of the credit note, - excluding all tax and invoice level discounts. + The integer amount in cents (or local equivalent) representing the + amount of the credit note, excluding all tax and invoice level + discounts. nullable: true type: integer tax_amounts: @@ -5958,13 +5968,14 @@ components: type: array total: description: >- - The integer amount in %s representing the total amount of the credit - note, including tax and all discount. + The integer amount in cents (or local equivalent) representing the + total amount of the credit note, including tax and all discount. type: integer total_excluding_tax: description: >- - The integer amount in %s representing the total amount of the credit - note, excluding tax, but including discounts. + The integer amount in cents (or local equivalent) representing the + total amount of the credit note, excluding tax, but including + discounts. nullable: true type: integer type: @@ -6015,18 +6026,19 @@ components: - tax_amounts x-resourceId: credit_note credit_note_line_item: - description: '' + description: The credit note line item object properties: amount: description: >- - The integer amount in %s representing the gross amount being - credited for this line item, excluding (exclusive) tax and - discounts. + The integer amount in cents (or local equivalent) representing the + gross amount being credited for this line item, excluding + (exclusive) tax and discounts. type: integer amount_excluding_tax: description: >- - The integer amount in %s representing the amount being credited for - this line item, excluding all tax and discounts. + The integer amount in cents (or local equivalent) representing the + amount being credited for this line item, excluding all tax and + discounts. nullable: true type: integer description: @@ -6036,8 +6048,8 @@ components: type: string discount_amount: description: >- - The integer amount in %s representing the discount being credited - for this line item. + The integer amount in cents (or local equivalent) representing the + discount being credited for this line item. type: integer discount_amounts: description: The amount of discount calculated per discount for this line item @@ -6101,8 +6113,9 @@ components: type: string unit_amount_excluding_tax: description: >- - The amount in %s representing the unit amount being credited for - this line item, excluding all tax and discounts. + The amount in cents (or local equivalent) representing the unit + amount being credited for this line item, excluding all tax and + discounts. format: decimal nullable: true type: string @@ -6127,7 +6140,7 @@ components: description: '' properties: amount: - description: 'The amount, in %s, of the tax.' + description: 'The amount, in cents (or local equivalent), of the tax.' type: integer inclusive: description: Whether this tax amount is inclusive or exclusive. @@ -6166,7 +6179,9 @@ components: type: string x-stripeBypassValidation: true taxable_amount: - description: 'The amount on which tax is calculated, in %s.' + description: >- + The amount on which tax is calculated, in cents (or local + equivalent). nullable: true type: integer required: @@ -6211,15 +6226,16 @@ components: type: array unit_amount: description: >- - The unit amount in %s to be charged, represented as a whole integer - if possible. Only set if `billing_scheme=per_unit`. + The unit amount in cents (or local equivalent) to be charged, + represented as a whole integer if possible. Only set if + `billing_scheme=per_unit`. nullable: true type: integer unit_amount_decimal: description: >- - The unit amount in %s to be charged, represented as a decimal string - with at most 12 decimal places. Only set if - `billing_scheme=per_unit`. + The unit amount in cents (or local equivalent) to be charged, + represented as a decimal string with at most 12 decimal places. Only + set if `billing_scheme=per_unit`. format: decimal nullable: true type: string @@ -6620,6 +6636,42 @@ components: title: CustomerBalanceCustomerBalanceSettings type: object x-expandableFields: [] + customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft: + description: '' + properties: + balance_transaction: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/balance_transaction' + description: >- + The [Balance Transaction](docs/api/balance_transactions/object) that + corresponds to funds taken out of your Stripe balance. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/balance_transaction' + linked_transaction: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/customer_cash_balance_transaction' + description: >- + The [Cash Balance + Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) + that brought the customer balance negative, triggering the clawback + of funds. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/customer_cash_balance_transaction' + required: + - balance_transaction + - linked_transaction + title: >- + CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft + type: object + x-expandableFields: + - balance_transaction + - linked_transaction customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction: description: '' properties: @@ -6984,6 +7036,9 @@ components: to payments, and refunds to the customer. properties: + adjusted_for_overdraft: + $ref: >- + #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft applied_to_payment: $ref: >- #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction @@ -7055,6 +7110,7 @@ components: Balance](https://stripe.com/docs/payments/customer-balance#types) to learn more about these types. enum: + - adjusted_for_overdraft - applied_to_payment - funded - funding_reversed @@ -7079,6 +7135,7 @@ components: title: CustomerCashBalanceTransaction type: object x-expandableFields: + - adjusted_for_overdraft - applied_to_payment - customer - funded @@ -7973,7 +8030,7 @@ components: description: '' properties: amount: - description: 'The amount, in %s, of the discount.' + description: 'The amount, in cents (or local equivalent), of the discount.' type: integer discount: anyOf: @@ -8091,6 +8148,8 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_intent' + payment_method_details: + $ref: '#/components/schemas/dispute_payment_method_details' reason: description: >- Reason given by cardholder for dispute. Possible values are @@ -8107,10 +8166,8 @@ components: description: >- Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, - `needs_response`, `under_review`, `charge_refunded`, `won`, or - `lost`. + `needs_response`, `under_review`, `won`, or `lost`. enum: - - charge_refunded - lost - needs_response - under_review @@ -8142,6 +8199,7 @@ components: - evidence - evidence_details - payment_intent + - payment_method_details x-resourceId: dispute dispute_evidence: description: '' @@ -8426,6 +8484,49 @@ components: title: DisputeEvidenceDetails type: object x-expandableFields: [] + dispute_payment_method_details: + description: '' + properties: + card: + anyOf: + - $ref: '#/components/schemas/dispute_payment_method_details_card' + description: Card specific dispute details. + nullable: true + type: + description: Payment method type. + enum: + - card + type: string + required: + - type + title: DisputePaymentMethodDetails + type: object + x-expandableFields: + - card + dispute_payment_method_details_card: + description: '' + properties: + brand: + description: >- + Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, + `mastercard`, `unionpay`, `visa`, or `unknown`. + maxLength: 5000 + type: string + network_reason_code: + description: >- + The card network's specific dispute reason code, which maps to one + of Stripe's primary dispute categories to simplify response + guidance. The [Network code + map](https://stripe.com/docs/disputes/categories#network-code-map) + lists all available dispute reason codes by network. + maxLength: 5000 + nullable: true + type: string + required: + - brand + title: DisputePaymentMethodDetailsCard + type: object + x-expandableFields: [] email_sent: description: '' properties: @@ -8796,7 +8897,7 @@ components: fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee) properties: amount: - description: 'Amount, in %s.' + description: 'Amount, in cents (or local equivalent).' type: integer balance_transaction: anyOf: @@ -10685,10 +10786,12 @@ components: invoice will be for the amount specified in `amount_due`. type: integer amount_paid: - description: 'The amount, in %s, that was paid.' + description: 'The amount, in cents (or local equivalent), that was paid.' type: integer amount_remaining: - description: 'The difference between amount_due and amount_paid, in %s.' + description: >- + The difference between amount_due and amount_paid, in cents (or + local equivalent). type: integer amount_shipping: description: This is the sum of all the shipping amounts. @@ -10707,8 +10810,9 @@ components: - $ref: '#/components/schemas/deleted_application' application_fee_amount: description: >- - The fee in %s that will be applied to the invoice and transferred to - the application owner's Stripe account when the invoice is paid. + The fee in cents (or local equivalent) that will be applied to the + invoice and transferred to the application owner's Stripe account + when the invoice is paid. nullable: true type: integer attempt_count: @@ -11255,9 +11359,9 @@ components: type: integer subtotal_excluding_tax: description: >- - The integer amount in %s representing the subtotal of the invoice - before any invoice level discount or tax is applied. Item discounts - are already incorporated + The integer amount in cents (or local equivalent) representing the + subtotal of the invoice before any invoice level discount or tax is + applied. Item discounts are already incorporated nullable: true type: integer tax: @@ -11289,8 +11393,9 @@ components: type: array total_excluding_tax: description: >- - The integer amount in %s representing the total amount of the - invoice including all discounts but excluding all tax. + The integer amount in cents (or local equivalent) representing the + total amount of the invoice including all discounts but excluding + all tax. nullable: true type: integer total_tax_amounts: @@ -11740,7 +11845,7 @@ components: description: '' properties: amount: - description: 'The amount, in %s, of the tax.' + description: 'The amount, in cents (or local equivalent), of the tax.' type: integer inclusive: description: Whether this tax amount is inclusive or exclusive. @@ -11779,7 +11884,9 @@ components: type: string x-stripeBypassValidation: true taxable_amount: - description: 'The amount on which tax is calculated, in %s.' + description: >- + The amount on which tax is calculated, in cents (or local + equivalent). nullable: true type: integer required: @@ -11815,9 +11922,9 @@ components: properties: amount: description: >- - The amount in %s that will be transferred to the destination account - when the invoice is paid. By default, the entire amount is - transferred to the destination. + The amount in cents (or local equivalent) that will be transferred + to the destination account when the invoice is paid. By default, the + entire amount is transferred to the destination. nullable: true type: integer destination: @@ -16699,6 +16806,7 @@ components: - government_instrumentality - governmental_unit - incorporated_non_profit + - incorporated_partnership - limited_liability_partnership - llc - multi_member_llc @@ -16714,6 +16822,7 @@ components: - tax_exempt_government_instrumentality - unincorporated_association - unincorporated_non_profit + - unincorporated_partnership type: string x-stripeBypassValidation: true tax_id_provided: @@ -16996,12 +17105,12 @@ components: description: '' properties: amount: - description: 'The amount, in %s.' + description: 'The amount, in cents (or local equivalent).' type: integer amount_excluding_tax: description: >- - The integer amount in %s representing the amount for this line item, - excluding all tax and discounts. + The integer amount in cents (or local equivalent) representing the + amount for this line item, excluding all tax and discounts. nullable: true type: integer currency: @@ -17147,8 +17256,8 @@ components: type: string unit_amount_excluding_tax: description: >- - The amount in %s representing the unit amount for this line item, - excluding all tax and discounts. + The amount in cents (or local equivalent) representing the unit + amount for this line item, excluding all tax and discounts. format: decimal nullable: true type: string @@ -17225,7 +17334,9 @@ components: type: string x-stripeBypassValidation: true taxable_amount: - description: 'The amount on which tax is calculated, in %s.' + description: >- + The amount on which tax is calculated, in cents (or local + equivalent). nullable: true type: integer required: @@ -17447,27 +17558,6 @@ components: title: mandate_bacs_debit type: object x-expandableFields: [] - mandate_blik: - description: '' - properties: - expires_after: - description: Date at which the mandate expires. - format: unix-time - nullable: true - type: integer - off_session: - $ref: '#/components/schemas/mandate_options_off_session_details_blik' - type: - description: Type of the mandate. - enum: - - off_session - - on_session - nullable: true - type: string - title: mandate_blik - type: object - x-expandableFields: - - off_session mandate_cashapp: description: '' properties: {} @@ -17486,34 +17576,6 @@ components: title: mandate_multi_use type: object x-expandableFields: [] - mandate_options_off_session_details_blik: - description: '' - properties: - amount: - description: Amount of each recurring payment. - nullable: true - type: integer - currency: - description: Currency of each recurring payment. - maxLength: 5000 - nullable: true - type: string - interval: - description: Frequency interval of each recurring payment. - enum: - - day - - month - - week - - year - nullable: true - type: string - interval_count: - description: Frequency indicator of each recurring payment. - nullable: true - type: integer - title: mandate_options_off_session_details_blik - type: object - x-expandableFields: [] mandate_payment_method_details: description: '' properties: @@ -17523,8 +17585,6 @@ components: $ref: '#/components/schemas/mandate_au_becs_debit' bacs_debit: $ref: '#/components/schemas/mandate_bacs_debit' - blik: - $ref: '#/components/schemas/mandate_blik' card: $ref: '#/components/schemas/card_mandate_payment_method_details' cashapp: @@ -17553,7 +17613,6 @@ components: - acss_debit - au_becs_debit - bacs_debit - - blik - card - cashapp - link @@ -19371,14 +19430,10 @@ components: x-expandableFields: [] payment_intent_payment_method_options_blik: description: '' - properties: - mandate_options: - $ref: >- - #/components/schemas/payment_intent_payment_method_options_mandate_options_blik + properties: {} title: payment_intent_payment_method_options_blik type: object - x-expandableFields: - - mandate_options + x-expandableFields: [] payment_intent_payment_method_options_card: description: '' properties: @@ -19590,27 +19645,6 @@ components: title: payment_intent_payment_method_options_mandate_options_acss_debit type: object x-expandableFields: [] - payment_intent_payment_method_options_mandate_options_blik: - description: '' - properties: - expires_after: - description: Date at which the mandate expires. - format: unix-time - nullable: true - type: integer - off_session: - $ref: '#/components/schemas/mandate_options_off_session_details_blik' - type: - description: Type of the mandate. - enum: - - off_session - - on_session - nullable: true - type: string - title: payment_intent_payment_method_options_mandate_options_blik - type: object - x-expandableFields: - - off_session payment_intent_payment_method_options_mandate_options_sepa_debit: description: '' properties: {} @@ -19656,6 +19690,12 @@ components: properties: financial_connections: $ref: '#/components/schemas/linked_account_options_us_bank_account' + preferred_settlement_speed: + description: Preferred transaction settlement speed + enum: + - fastest + - standard + type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this @@ -20755,9 +20795,9 @@ components: properties: amount: description: >- - The amount in %s that will be transferred to the destination - account. By default, the entire amount is transferred to the - destination. + The amount in cents (or local equivalent) that will be transferred + to the destination account. By default, the entire amount is + transferred to the destination. nullable: true type: integer destination: @@ -22065,7 +22105,7 @@ components: nullable: true three_d_secure: anyOf: - - $ref: '#/components/schemas/three_d_secure_details' + - $ref: '#/components/schemas/three_d_secure_details_charge' description: Populated if this transaction used 3D Secure authentication. nullable: true wallet: @@ -25991,7 +26031,9 @@ components: Related guide: [Receiving payouts](https://stripe.com/docs/payouts) properties: amount: - description: Amount (in %s) to be transferred to your bank account or debit card. + description: >- + Amount (in cents (or local equivalent)) to be transferred to your + bank account or debit card. type: integer arrival_date: description: >- @@ -26660,15 +26702,16 @@ components: type: string amount: description: >- - The unit amount in %s to be charged, represented as a whole integer - if possible. Only set if `billing_scheme=per_unit`. + The unit amount in cents (or local equivalent) to be charged, + represented as a whole integer if possible. Only set if + `billing_scheme=per_unit`. nullable: true type: integer amount_decimal: description: >- - The unit amount in %s to be charged, represented as a decimal string - with at most 12 decimal places. Only set if - `billing_scheme=per_unit`. + The unit amount in cents (or local equivalent) to be charged, + represented as a decimal string with at most 12 decimal places. Only + set if `billing_scheme=per_unit`. format: decimal nullable: true type: string @@ -27513,15 +27556,16 @@ components: type: string unit_amount: description: >- - The unit amount in %s to be charged, represented as a whole integer - if possible. Only set if `billing_scheme=per_unit`. + The unit amount in cents (or local equivalent) to be charged, + represented as a whole integer if possible. Only set if + `billing_scheme=per_unit`. nullable: true type: integer unit_amount_decimal: description: >- - The unit amount in %s to be charged, represented as a decimal string - with at most 12 decimal places. Only set if - `billing_scheme=per_unit`. + The unit amount in cents (or local equivalent) to be charged, + represented as a decimal string with at most 12 decimal places. Only + set if `billing_scheme=per_unit`. format: decimal nullable: true type: string @@ -28412,9 +28456,9 @@ components: properties: amount: description: >- - The amount in %s that will be transferred to the destination account - when the invoice is paid. By default, the entire amount is - transferred to the destination. + The amount in cents (or local equivalent) that will be transferred + to the destination account when the invoice is paid. By default, the + entire amount is transferred to the destination. nullable: true type: integer amount_percent: @@ -28919,7 +28963,7 @@ components: Related guide: [Refunds](https://stripe.com/docs/refunds) properties: amount: - description: 'Amount, in %s.' + description: 'Amount, in cents (or local equivalent).' type: integer balance_transaction: anyOf: @@ -29821,8 +29865,6 @@ components: $ref: '#/components/schemas/setup_attempt_payment_method_details_bacs_debit' bancontact: $ref: '#/components/schemas/setup_attempt_payment_method_details_bancontact' - blik: - $ref: '#/components/schemas/setup_attempt_payment_method_details_blik' boleto: $ref: '#/components/schemas/setup_attempt_payment_method_details_boleto' card: @@ -29864,7 +29906,6 @@ components: - au_becs_debit - bacs_debit - bancontact - - blik - boleto - card - card_present @@ -29969,12 +30010,6 @@ components: x-expandableFields: - generated_sepa_debit - generated_sepa_debit_mandate - setup_attempt_payment_method_details_blik: - description: '' - properties: {} - title: setup_attempt_payment_method_details_blik - type: object - x-expandableFields: [] setup_attempt_payment_method_details_boleto: description: '' properties: {} @@ -30404,7 +30439,7 @@ components: - $ref: >- #/components/schemas/payment_flows_automatic_payment_methods_setup_intent description: >- - Settings for automatic payment methods compatible with this Setup + Settings for dynamic payment methods compatible with this Setup Intent nullable: true cancellation_reason: @@ -30717,11 +30752,6 @@ components: #/components/schemas/setup_intent_payment_method_options_acss_debit - $ref: >- #/components/schemas/setup_intent_type_specific_payment_method_options_client - blik: - anyOf: - - $ref: '#/components/schemas/setup_intent_payment_method_options_blik' - - $ref: >- - #/components/schemas/setup_intent_type_specific_payment_method_options_client card: $ref: '#/components/schemas/setup_intent_payment_method_options_card' link: @@ -30750,7 +30780,6 @@ components: type: object x-expandableFields: - acss_debit - - blik - card - link - paypal @@ -30781,16 +30810,6 @@ components: type: object x-expandableFields: - mandate_options - setup_intent_payment_method_options_blik: - description: '' - properties: - mandate_options: - $ref: >- - #/components/schemas/setup_intent_payment_method_options_mandate_options_blik - title: setup_intent_payment_method_options_blik - type: object - x-expandableFields: - - mandate_options setup_intent_payment_method_options_card: description: '' properties: @@ -30980,27 +30999,6 @@ components: title: setup_intent_payment_method_options_mandate_options_acss_debit type: object x-expandableFields: [] - setup_intent_payment_method_options_mandate_options_blik: - description: '' - properties: - expires_after: - description: Date at which the mandate expires. - format: unix-time - nullable: true - type: integer - off_session: - $ref: '#/components/schemas/mandate_options_off_session_details_blik' - type: - description: Type of the mandate. - enum: - - off_session - - on_session - nullable: true - type: string - title: setup_intent_payment_method_options_mandate_options_blik - type: object - x-expandableFields: - - off_session setup_intent_payment_method_options_mandate_options_sepa_debit: description: '' properties: {} @@ -35503,8 +35501,13 @@ components: effective_percentage: description: >- Actual/effective tax rate percentage out of 100. For tax - calculations with automatic_tax[enabled]=true, this percentage does - not include the statutory tax rate of non-taxable jurisdictions. + calculations with automatic_tax[enabled]=true, + + this percentage reflects the rate actually used to calculate tax + based on the product's taxability + + and whether the user is registered to collect taxes in the + corresponding jurisdiction. nullable: true type: number id: @@ -36017,6 +36020,12 @@ components: x-expandableFields: - payment_intent - process_config + terminal_reader_reader_resource_process_setup_config: + description: Represents a per-setup override of a reader configuration + properties: {} + title: TerminalReaderReaderResourceProcessSetupConfig + type: object + x-expandableFields: [] terminal_reader_reader_resource_process_setup_intent_action: description: Represents a reader action to process a setup intent properties: @@ -36028,6 +36037,9 @@ components: PaymentMethod. maxLength: 5000 type: string + process_config: + $ref: >- + #/components/schemas/terminal_reader_reader_resource_process_setup_config setup_intent: anyOf: - maxLength: 5000 @@ -36042,6 +36054,7 @@ components: title: TerminalReaderReaderResourceProcessSetupIntentAction type: object x-expandableFields: + - process_config - setup_intent terminal_reader_reader_resource_reader_action: description: Represents an action performed by the reader @@ -36316,6 +36329,57 @@ components: title: three_d_secure_details type: object x-expandableFields: [] + three_d_secure_details_charge: + description: '' + properties: + authentication_flow: + description: >- + For authenticated transactions: how the customer was authenticated + by + + the issuing bank. + enum: + - challenge + - frictionless + nullable: true + type: string + result: + description: Indicates the outcome of 3D Secure authentication. + enum: + - attempt_acknowledged + - authenticated + - exempted + - failed + - not_supported + - processing_error + nullable: true + type: string + result_reason: + description: |- + Additional information about why 3D Secure succeeded or failed based + on the `result`. + enum: + - abandoned + - bypassed + - canceled + - card_not_enrolled + - network_not_supported + - protocol_error + - rejected + nullable: true + type: string + version: + description: The version of 3D Secure that was used. + enum: + - 1.0.2 + - 2.1.0 + - 2.2.0 + nullable: true + type: string + x-stripeBypassValidation: true + title: three_d_secure_details_charge + type: object + x-expandableFields: [] three_d_secure_usage: description: '' properties: @@ -36605,12 +36669,12 @@ components: transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) properties: amount: - description: Amount in %s to be transferred. + description: Amount in cents (or local equivalent) to be transferred. type: integer amount_reversed: description: >- - Amount in %s reversed (can be less than the amount attribute on the - transfer if a partial reversal was issued). + Amount in cents (or local equivalent) reversed (can be less than the + amount attribute on the transfer if a partial reversal was issued). type: integer balance_transaction: anyOf: @@ -36839,7 +36903,7 @@ components: transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reversing-transfers) properties: amount: - description: 'Amount, in %s.' + description: 'Amount, in cents (or local equivalent).' type: integer balance_transaction: anyOf: @@ -39603,7 +39667,7 @@ info: details. termsOfService: 'https://stripe.com/us/terms/' title: Stripe API - version: '2022-11-15' + version: '2023-08-16' x-stripeSpecFilename: spec3 openapi: 3.0.0 paths: @@ -40393,6 +40457,7 @@ paths: - government_instrumentality - governmental_unit - incorporated_non_profit + - incorporated_partnership - limited_liability_partnership - llc - multi_member_llc @@ -40408,6 +40473,7 @@ paths: - tax_exempt_government_instrumentality - unincorporated_association - unincorporated_non_profit + - unincorporated_partnership type: string x-stripeBypassValidation: true tax_id: @@ -40982,8 +41048,8 @@ paths:

If you want to delete your own account, use the account information tab in - your account settings instead.

+ href="https://dashboard.stripe.com/settings/account">account information + tab in your account settings instead.

operationId: DeleteAccountsAccount parameters: - in: path @@ -41082,7 +41148,8 @@ paths:

To update your own account, use the Dashboard. Refer to our + href="https://dashboard.stripe.com/settings/account">Dashboard. + Refer to our Connect documentation to learn more about updating accounts.

@@ -41557,6 +41624,7 @@ paths: - government_instrumentality - governmental_unit - incorporated_non_profit + - incorporated_partnership - limited_liability_partnership - llc - multi_member_llc @@ -41572,6 +41640,7 @@ paths: - tax_exempt_government_instrumentality - unincorporated_association - unincorporated_non_profit + - unincorporated_partnership type: string x-stripeBypassValidation: true tax_id: @@ -46634,11 +46703,12 @@ paths: `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, - `payment_failure_refund`, `payment_refund`, `payout`, - `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, - `reserve_transaction`, `reserved_funds`, `stripe_fee`, - `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, - `transfer_cancel`, `transfer_failure`, or `transfer_refund`. + `payment_failure_refund`, `payment_refund`, `payment_reversal`, + `payout`, `payout_cancel`, `payout_failure`, `refund`, + `refund_failure`, `reserve_transaction`, `reserved_funds`, + `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, + `transfer`, `transfer_cancel`, `transfer_failure`, or + `transfer_refund`. in: query name: type required: false @@ -46863,11 +46933,12 @@ paths: `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, - `payment_failure_refund`, `payment_refund`, `payout`, - `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, - `reserve_transaction`, `reserved_funds`, `stripe_fee`, - `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, - `transfer_cancel`, `transfer_failure`, or `transfer_refund`. + `payment_failure_refund`, `payment_refund`, `payment_reversal`, + `payout`, `payout_cancel`, `payout_failure`, `refund`, + `refund_failure`, `reserve_transaction`, `reserved_funds`, + `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, + `transfer`, `transfer_cancel`, `transfer_failure`, or + `transfer_refund`. in: query name: type required: false @@ -47800,7 +47871,7 @@ paths: type: object locale: description: >- - The IETF language tag of the locale Customer Portal is + The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used. enum: @@ -64324,9 +64395,8 @@ paths: type: array style: deepObject - description: >- - The identifier of the unstarted schedule whose upcoming invoice - you'd like to retrieve. Cannot be used with subscription or - subscription fields. + The identifier of the schedule whose upcoming invoice you'd like to + retrieve. Cannot be used with subscription or subscription fields. in: query name: schedule required: false @@ -65036,9 +65106,8 @@ paths: type: integer style: form - description: >- - The identifier of the unstarted schedule whose upcoming invoice - you'd like to retrieve. Cannot be used with subscription or - subscription fields. + The identifier of the schedule whose upcoming invoice you'd like to + retrieve. Cannot be used with subscription or subscription fields. in: query name: schedule required: false @@ -75110,30 +75179,6 @@ paths: code: maxLength: 5000 type: string - mandate_options: - properties: - expires_after: - type: integer - off_session: - properties: - interval: - enum: - - day - - month - - week - - year - type: string - interval_count: - type: integer - required: - - interval - - interval_count - title: >- - mandate_options_off_session_details_common_param - type: object - title: >- - payment_intent_payment_method_options_mandate_options_param - type: object title: payment_intent_payment_method_options_param type: object - enum: @@ -75762,6 +75807,12 @@ paths: type: array title: networks_options_param type: object + preferred_settlement_speed: + enum: + - '' + - fastest + - standard + type: string setup_future_usage: enum: - '' @@ -76915,30 +76966,6 @@ paths: code: maxLength: 5000 type: string - mandate_options: - properties: - expires_after: - type: integer - off_session: - properties: - interval: - enum: - - day - - month - - week - - year - type: string - interval_count: - type: integer - required: - - interval - - interval_count - title: >- - mandate_options_off_session_details_common_param - type: object - title: >- - payment_intent_payment_method_options_mandate_options_param - type: object title: payment_intent_payment_method_options_param type: object - enum: @@ -77567,6 +77594,12 @@ paths: type: array title: networks_options_param type: object + preferred_settlement_speed: + enum: + - '' + - fastest + - standard + type: string setup_future_usage: enum: - '' @@ -78849,30 +78882,6 @@ paths: code: maxLength: 5000 type: string - mandate_options: - properties: - expires_after: - type: integer - off_session: - properties: - interval: - enum: - - day - - month - - week - - year - type: string - interval_count: - type: integer - required: - - interval - - interval_count - title: >- - mandate_options_off_session_details_common_param - type: object - title: >- - payment_intent_payment_method_options_mandate_options_param - type: object title: payment_intent_payment_method_options_param type: object - enum: @@ -79501,6 +79510,12 @@ paths: type: array title: networks_options_param type: object + preferred_settlement_speed: + enum: + - '' + - fastest + - standard + type: string setup_future_usage: enum: - '' @@ -81292,8 +81307,8 @@ paths: type: string description: >- The list of payment method types that customers can use. - Pass an empty string to enable automatic payment methods - that use your [payment method + Pass an empty string to enable dynamic payment methods that + use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). shipping_address_collection: anyOf: @@ -90747,44 +90762,6 @@ paths: x-stripeBypassValidation: true title: setup_intent_payment_method_options_param type: object - blik: - properties: - code: - maxLength: 5000 - type: string - mandate_options: - properties: - expires_after: - type: integer - off_session: - properties: - amount: - type: integer - currency: - enum: - - pln - type: string - interval: - enum: - - day - - month - - week - - year - type: string - interval_count: - type: integer - required: - - amount - - currency - - interval - - interval_count - title: mandate_options_off_session_details_param - type: object - title: >- - setup_intent_payment_method_options_mandate_options_param - type: object - title: setup_intent_payment_method_options_param - type: object card: properties: mandate_options: @@ -91633,44 +91610,6 @@ paths: x-stripeBypassValidation: true title: setup_intent_payment_method_options_param type: object - blik: - properties: - code: - maxLength: 5000 - type: string - mandate_options: - properties: - expires_after: - type: integer - off_session: - properties: - amount: - type: integer - currency: - enum: - - pln - type: string - interval: - enum: - - day - - month - - week - - year - type: string - interval_count: - type: integer - required: - - amount - - currency - - interval - - interval_count - title: mandate_options_off_session_details_param - type: object - title: >- - setup_intent_payment_method_options_mandate_options_param - type: object - title: setup_intent_payment_method_options_param - type: object card: properties: mandate_options: @@ -92503,44 +92442,6 @@ paths: x-stripeBypassValidation: true title: setup_intent_payment_method_options_param type: object - blik: - properties: - code: - maxLength: 5000 - type: string - mandate_options: - properties: - expires_after: - type: integer - off_session: - properties: - amount: - type: integer - currency: - enum: - - pln - type: string - interval: - enum: - - day - - month - - week - - year - type: string - interval_count: - type: integer - required: - - amount - - currency - - interval - - interval_count - title: mandate_options_off_session_details_param - type: object - title: >- - setup_intent_payment_method_options_mandate_options_param - type: object - title: setup_intent_payment_method_options_param - type: object card: properties: mandate_options: @@ -99189,6 +99090,12 @@ paths: maxLength: 5000 type: string type: array + flat_amount: + description: >- + A flat amount to reverse across the entire transaction, in + negative integer cents. This value represents the total + amount to refund from the transaction, including taxes. + type: integer line_items: description: The line item amounts to reverse. items: @@ -101713,6 +101620,9 @@ paths: expand: explode: true style: deepObject + process_config: + explode: true + style: deepObject schema: additionalProperties: false properties: @@ -101725,6 +101635,11 @@ paths: maxLength: 5000 type: string type: array + process_config: + description: Configuration overrides + properties: {} + title: process_setup_config + type: object setup_intent: description: SetupIntent ID maxLength: 5000 @@ -103417,6 +103332,7 @@ paths: - government_instrumentality - governmental_unit - incorporated_non_profit + - incorporated_partnership - limited_liability_partnership - llc - multi_member_llc @@ -103432,6 +103348,7 @@ paths: - tax_exempt_government_instrumentality - unincorporated_association - unincorporated_non_profit + - unincorporated_partnership type: string x-stripeBypassValidation: true tax_id: @@ -108574,6 +108491,7 @@ paths: - '2020-08-27' - '2022-08-01' - '2022-11-15' + - '2023-08-16' maxLength: 5000 type: string x-stripeBypassValidation: true diff --git a/packages/openapi-typescript/src/index.ts b/packages/openapi-typescript/src/index.ts index 06d0d5f3a..7e012760a 100644 --- a/packages/openapi-typescript/src/index.ts +++ b/packages/openapi-typescript/src/index.ts @@ -1,4 +1,4 @@ -import type { GlobalContext, OpenAPI3, OpenAPITSOptions, SchemaObject, Subschema } from "./types.js"; +import type { GlobalContext, OpenAPI3, OpenAPITSOptions, ParameterObject, SchemaObject, Subschema } from "./types.js"; import type { Readable } from "node:stream"; import { URL } from "node:url"; import load, { resolveSchema, VIRTUAL_JSON_URL } from "./load.js"; @@ -40,6 +40,7 @@ async function openapiTS(schema: string | URL | OpenAPI3 | Readable, options: Op const ctx: GlobalContext = { additionalProperties: options.additionalProperties ?? false, alphabetize: options.alphabetize ?? false, + cwd: options.cwd ?? new URL(`file://${process.cwd()}/`), defaultNonNullable: options.defaultNonNullable ?? false, discriminators: {}, transform: typeof options.transform === "function" ? options.transform : undefined, @@ -55,17 +56,31 @@ async function openapiTS(schema: string | URL | OpenAPI3 | Readable, options: Op excludeDeprecated: options.excludeDeprecated ?? false, }; - // note: we may be loading many large schemas into memory at once; take care to reuse references without cloning - const isInlineSchema = typeof schema !== "string" && schema instanceof URL === false; // eslint-disable-line @typescript-eslint/no-unnecessary-boolean-literal-compare - // 1. load schema (and subschemas) const allSchemas: { [id: string]: Subschema } = {}; const schemaURL: URL = typeof schema === "string" ? resolveSchema(schema) : (schema as URL); + let rootURL: URL = schemaURL; + + // 1a. if passed as in-memory JSON, handle `cwd` option + const isInlineSchema = typeof schema !== "string" && schema instanceof URL === false; // eslint-disable-line @typescript-eslint/no-unnecessary-boolean-literal-compare + if (isInlineSchema) { + if (ctx.cwd) { + if (ctx.cwd instanceof URL) { + rootURL = ctx.cwd; + } else if (typeof ctx.cwd === "string") { + rootURL = new URL(ctx.cwd, `file://${process.cwd()}/`); + } + rootURL = new URL("root.yaml", rootURL); // give the root schema an arbitrary filename ("root.yaml") + } else { + rootURL = new URL(VIRTUAL_JSON_URL); // otherwise, set virtual filename (which prevents resolutions) + } + } + await load(schemaURL, { ...ctx, auth: options.auth, schemas: allSchemas, - rootURL: isInlineSchema ? new URL(VIRTUAL_JSON_URL) : schemaURL, // if an inline schema is passed, use virtual URL + rootURL, urlCache: new Set(), httpHeaders: options.httpHeaders, httpMethod: options.httpMethod, @@ -185,7 +200,7 @@ async function openapiTS(schema: string | URL | OpenAPI3 | Readable, options: Op const c = getSchemaObjectComment(schemaObject as SchemaObject, indentLv); if (c) subschemaOutput += indent(c, indentLv); - // This might be a Path Item Object; only way to test is if top-level contains a method (not allowed on Schema Object) + // Test for Path Item Object if (!("type" in schemaObject) && !("$ref" in schemaObject)) { for (const method of ["get", "put", "post", "delete", "options", "head", "patch", "trace"] as Method[]) { if (method in schemaObject) { @@ -194,6 +209,11 @@ async function openapiTS(schema: string | URL | OpenAPI3 | Readable, options: Op } } } + // Test for Parameter + if ("in" in schemaObject) { + subschemaOutput += indent(`${escObjKey(name)}: ${transformParameterObject(schemaObject as ParameterObject, { path: `${path}${name}`, ctx: { ...ctx, indentLv } })};\n`, indentLv); + continue; + } // Otherwise, this is a Schema Object subschemaOutput += indent(`${escObjKey(name)}: ${transformSchemaObject(schemaObject, { path: `${path}${name}`, ctx: { ...ctx, indentLv } })};\n`, indentLv); @@ -204,7 +224,7 @@ async function openapiTS(schema: string | URL | OpenAPI3 | Readable, options: Op break; } case "SchemaObject": { - subschemaOutput = transformSchemaObject(subschema.schema, { path, ctx: { ...ctx, indentLv } }); + subschemaOutput = `${transformSchemaObject(subschema.schema, { path, ctx: { ...ctx, indentLv } })};`; break; } default: { diff --git a/packages/openapi-typescript/src/load.ts b/packages/openapi-typescript/src/load.ts index 986219a1e..70dcbabeb 100644 --- a/packages/openapi-typescript/src/load.ts +++ b/packages/openapi-typescript/src/load.ts @@ -11,7 +11,7 @@ interface SchemaMap { [id: string]: Subschema; } -const EXT_RE = /\.(yaml|yml|json)$/i; +const EXT_RE = /\.(yaml|yml|json)#?\/?/i; export const VIRTUAL_JSON_URL = `file:///_json`; // fake URL reserved for dynamic JSON function parseYAML(schema: string) { @@ -69,7 +69,7 @@ function parseHttpHeaders(httpHeaders: Record): Record { - const generated = await openapiTS(new URL("./fixtures/remote-ref-test.yaml", import.meta.url)); - expect(generated).toBe(`${BOILERPLATE} + describe("remote $refs", () => { + const expected = `${BOILERPLATE} export interface paths { "/": { get: { @@ -303,29 +303,28 @@ export interface paths { }; }; }; + "/ref-path": external["nested-ref/_nested-ref-partial.yaml"]; } export type webhooks = Record; export interface components { schemas: { - RemoteType: external["remote-ref-test-2.yaml"]["components"]["schemas"]["SchemaType"]; - RemotePartialType: external["_schema-test-partial.yaml"]["PartialType"]; + NestedType: external["nested-ref/nested-ref-2/nested-ref-3/_nested-ref-3.yaml"]; + RemoteType: external["_remote-ref-full.yaml"]["components"]["schemas"]["SchemaType"]; + RemotePartialType: external["_remote-ref-partial.yaml"]["PartialType"]; }; responses: never; - parameters: never; + parameters: { + NestedParam: external["nested-ref/_nested-ref-partial.yaml"]; + }; requestBodies: never; headers: never; pathItems: never; } export interface external { - "_schema-test-partial.yaml": { - PartialType: { - foo: string; - }; - }; - "remote-ref-test-2.yaml": { + "_remote-ref-full.yaml": { paths: { "/": { get: { @@ -353,10 +352,58 @@ export interface external { pathItems: never; }; }; + "_remote-ref-partial.yaml": { + PartialType: { + foo: string; + }; + }; + "nested-ref/_nested-ref-partial.yaml": { + "/ref-path": { + get: { + responses: { + /** @description OK */ + 200: { + content: { + "application/json": external["nested-ref/nested-ref-2/_nested-ref-2.yaml"]; + }; + }; + }; + }; + }; + StringParam: string; + }; + "nested-ref/nested-ref-2/_nested-ref-2.yaml": { + string?: string; + }; + "nested-ref/nested-ref-2/nested-ref-3/_nested-ref-3.yaml": external["nested-ref/nested-ref-2/_nested-ref-2.yaml"]; } export type operations = Record; -`); +`; + + /** test that remote $refs are loaded correctly */ + test("remote $refs", async () => { + const generated = await openapiTS(new URL("./fixtures/remote-ref-test.yaml", import.meta.url)); + expect(generated).toBe(expected); + }); + + test("remote $refs (string path)", async () => { + // mock process.cwd() so this test doesn’t throw just because you’re not in a specific directory + vi.mock("process", () => ({ cwd: () => fileURLToPath(import.meta.url) })); + + const generated = await openapiTS("test/fixtures/remote-ref-test.yaml"); + expect(generated).toBe(expected); + + // unmock process.cwd() + vi.unmock("process"); + }); + + test("remote $refs (root schema JS object)", async () => { + const cwd = new URL("./fixtures/", import.meta.url); + const root = yaml.load(fs.readFileSync(new URL("remote-ref-test.yaml", cwd), "utf8")); + const generated = await openapiTS(root as any, { cwd }); + expect(generated).toBe(expected); + }); }); /** test that path item objects accept $refs at the top level */